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.20.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bc79616d2ab62a63cc7e824932dde90deea28e4a7a470a2ad42b270ff62f87c |
|
MD5 | 97f918483a50a0ce80ca4b1d39cfdf94 |
|
BLAKE2b-256 | bee8af8e942d882bf6b4f9da8c55d21e45f3318b83a77edd37b65a3a266065c9 |
Close
Hashes for kabbes_smart_documentation-0.20.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 947a1e4dafb8748011030d544396f9998acb4a71104e67ea5319685de37b87f7 |
|
MD5 | 2880b9cdab51174f2b9c8f159ad3e027 |
|
BLAKE2b-256 | 3f299ec3f9d1c6158ab6f50739046d46914895db73eec179acd06086f3050a31 |