No project description provided
Project description
smart_documentation
Package for automatically generating documentation for Python repositories
Steps to Set Up
- copy the docs directory over to repository you are trying to auto document
- make a workflows directory nested in a .github directory
mkdir .github/workflows/
- copy the make.yml file over to the workflows directory
- adjust the project title in conf.py in the docs directory (found by searching "project title")
- if project not stored in scr/"projecttitle"__ continue
- replace "src" in the api.rst in the docs directory to the folder you want documented
- replace the "src" in the "ml_pipeline <_autosummary/src>" on the last line of the index.rst in the docs directory to the folder you want documented
Usage Tips
- make sure the requirements.txt file is right since it won't build unless dependecies are installed correctly
- be sure to check that Gitpages are set up right for the repositorie
- if unable to push to gh-pages branch, create and push another to GitHub
git branch gh-pages
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for kabbes_smart_documentation-0.17.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c6b5ce361425ae96ef4e70b5209c551ee2ba024ccab947ce98ab90d6acf4129 |
|
MD5 | 2bb5de01815208329558fd97006bd0de |
|
BLAKE2b-256 | b7d3a08059ad011565dbf445fba0108d07ca4a5d7761a4fd07036bf992722f27 |
Close
Hashes for kabbes_smart_documentation-0.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 172fb979de00d4b4fc65bb88a8f28d9d42bd84617c0311b66c38ebd7fbd10020 |
|
MD5 | b083c367811c00b5d2f667b9a9e73f56 |
|
BLAKE2b-256 | 141ffcadf343d1a90de891c4beaafdc750349a6b9cd3fd46a0f2174d61999aff |