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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12edf022236f77213a8038d479ea9e0317afe0444f03edb7bc49a88826f5db1b |
|
MD5 | 19af4637da357ee60ad0935e395c90f9 |
|
BLAKE2b-256 | 31bd9ce9aa1a30b7a2ca1c23889e4361194cfeab95eb2b067a4c4cf77a1e5ce8 |
Close
Hashes for kabbes_smart_documentation-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9afc742f3372e406961b7049bd5cb4baeccb2d3bce000cae983792f14740b74b |
|
MD5 | 109fe0e25da4566646e0cdb98c0847ec |
|
BLAKE2b-256 | 744c58357834bf3c2b9a62b59ca07e321e3c678cd18de264425e074b333cce0b |