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.19.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe87536184eb7ad63a3bb15284253d5a1f7bc6671d87ec1b0be01b70de0816e2 |
|
MD5 | e79f3a81cc7e37081e134b1ca1dff148 |
|
BLAKE2b-256 | f2ede057b93a0ee2eed558b5fc7081318eb175d2994102feeb13934b7491c4e4 |
Close
Hashes for kabbes_smart_documentation-0.19.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a64088cdf52f2c20b1cabe7842aa287fd8c6d17acf6ad08eb15fc67885b169e5 |
|
MD5 | f46896951a5bb20b4f655914c3f05fea |
|
BLAKE2b-256 | 69bfdca9a4d9e22cba2c3bebbfda7fd52eaa1d7035a23b581732420894ba911e |