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.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3555f659049b215e4481d11b3f8b12355fe58afe9c14f030d101546d9893edd7 |
|
MD5 | e585624d096ba53ba6539e86dc902aea |
|
BLAKE2b-256 | d731e8e5a835ac5a82a075390bbde65cec8fdb00032a250d2ff480a3704918a3 |
Close
Hashes for kabbes_smart_documentation-0.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1514eefb0d2c8d0bdcca716bcbe8c554ef272bff20e7b76ccff9f7a0907b2af |
|
MD5 | 2a1686ebac447b63d218d19ee527b87a |
|
BLAKE2b-256 | 480129a1812f5bbab6ab119e38d8c610e4ace6c9a5ff27636ca858c92d6832e9 |