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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90ef51fefd8fa0a61ee120610f6a1838d2747018e756e2168a682b49a7efd301 |
|
MD5 | c0dc6e080da3d426bdeee26d9a9ace31 |
|
BLAKE2b-256 | 7da2dd193b2c221fe46b462af504274e6d41b61d69ff4e02a2c37467a889808f |
Close
Hashes for kabbes_smart_documentation-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 554f357384592c7c7575f67ec7bceed2b50d73e478f83beafc7b1b9831964c70 |
|
MD5 | 00c7d19a1ba563ad790f9362fe68b972 |
|
BLAKE2b-256 | 1b1fe3f8a404a416354ca780a051c00faa517ace1859264c768be2c06839cbe3 |