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.18.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecc788143652e1c3dbcd632d28997f0b6547dcea3351cdcf4495e9e5411357b7 |
|
MD5 | 0c682270f62df65ddb06036382077de3 |
|
BLAKE2b-256 | 3ba7930eafdec60332eb1345ef9c83f0d2f258884d6d8946b40044ba84d48ed5 |
Close
Hashes for kabbes_smart_documentation-0.18.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ba89ff8267c72c09e90f0103e05ac5d00b4ea536dc694d05a8ee42d7c748390 |
|
MD5 | eef0b6e89c579cadec94abeb485e79a0 |
|
BLAKE2b-256 | fe25179be304267470861f4413801a28ec28314c86c9a698c77d019107f06203 |