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.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96d54ca50276df780b2e3887196d1f44eb95631532cf51039347124552e59d25 |
|
MD5 | 209c33002d85928078e79ff95bba1b47 |
|
BLAKE2b-256 | 905aa783b53fc8a3172c4135220758a2f098ccd63d2f860984bed468d63b4433 |
Close
Hashes for kabbes_smart_documentation-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3781a283a06cf0dbb8720269d71dd77a586cdc9037c0f45b2b87e9e3d7b52e5e |
|
MD5 | 795fa9b935a0b5cf3085f6835b0d5203 |
|
BLAKE2b-256 | ded4b84f8e66b14727f008b2536370d0c1df317ee0821611e62b4749c00b4dd8 |