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.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50c342a4c43bf2cfdda776252a912838b008f5423801ffc0826afc8b996886c0 |
|
MD5 | 3ab74d744b05dce209b04b6d4aa5bf88 |
|
BLAKE2b-256 | ccc95767b481d0f84a8951d177a40d329f22686198420416692e161aee1f52a1 |
Close
Hashes for kabbes_smart_documentation-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 877140e14b64c7bff667b78b914a7bc2189e977bbc65851edbbbc42f120523f9 |
|
MD5 | 20bfe711ec877f2d0faf63f33985695f |
|
BLAKE2b-256 | bb5565d58290d52a47d3adee6057f518a49d8eb3d38e5e488bf0c32ef4d443fb |