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.15.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5477ced6a62d2dff0c2d85303a5fc75179f78339073b157ead1d11dacf6c9f45 |
|
MD5 | f22401c38b9d0b82981be0fd5e6803a8 |
|
BLAKE2b-256 | e12c9b99f74c60b7d24dfe25779e85e1c54dac685de205b75ea6b002f44fb549 |
Close
Hashes for kabbes_smart_documentation-0.15.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24513f810e2561f9a122301f5fb12dd73b98058d1db34f094cbf2b3d98fb29ea |
|
MD5 | a40d45c6a575e82444af605b768da7d7 |
|
BLAKE2b-256 | fa1505adfa7758b2e1ef8c3cc4c675f16bf85ef0a023dd4598414614d1557db7 |