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.14.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6bd0a3b959adf2bd90c319d03d1532707f337b39e76bc4bc128ed5346974833f |
|
MD5 | 9ce2b2f7e2f099e7c10faa5553fd393b |
|
BLAKE2b-256 | 4ad532cd7d5414c4832eaaf6d80e5630714d1cf576dc7dcdb4a106e32ba5316f |
Close
Hashes for kabbes_smart_documentation-0.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73ed5ce6d55d3a3713353a37ed4f98f444850b9ce1fb9b372fa85d14fc288ec2 |
|
MD5 | 36017a1ec6bd2f700b8593f5d3f64619 |
|
BLAKE2b-256 | c9cd33d01292dd62114bf4f54068b7d7f6ad3287f6920e7e16190f7cd1f6b74e |