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.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d43b59bc0803b84293663516ccffdf0f228c7b7bc6f3bb87315a34dc67d1f05 |
|
MD5 | 88b14f4574d07cecef8e7730a906a7d9 |
|
BLAKE2b-256 | 6a37dd1a86230877395d6ddb156b6436d3bf91b74170034e02327763088be01f |
Close
Hashes for kabbes_smart_documentation-0.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfc505d6631ae800b862d5f2f0fde98f5cb8a77f1f922f7b248d7c52da7880ab |
|
MD5 | fddbee48bdd39916df51ae2c6bd732f8 |
|
BLAKE2b-256 | 587703d7baeaba5090060d5d4243722d6be8dbb88baf5827c196ef37b215831f |