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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3899c579d81fd5cb8b4e8897f1a2630f82ac627017390490d82a5340fb58b176 |
|
MD5 | d21262a2fcfc3004cb48c6fe0f9d8af4 |
|
BLAKE2b-256 | f4831b25bc9591d7e0f25e6e93f48f1ef6e024f795ff6bf6102e6f2f6156c869 |
Close
Hashes for kabbes_smart_documentation-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b430fd2465f12c7ddeeaec56920f391e3b7a4366bb58a89632d571f09109f278 |
|
MD5 | 0dcc134ccd6f69a8c1af122d6485507f |
|
BLAKE2b-256 | ecddd138ac33920a7ddc53a7c44ab72cbfb52cab6611910df86168d34706fb52 |