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.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fff184f457195282926f2e3fc62e938e7ee481da816cb8ee0829c507e5fe7e76 |
|
MD5 | ca34c4690fcf08f527c0a0a913fcbe00 |
|
BLAKE2b-256 | ad7a09f1f8424a627ece43d69b6ac090cc7360b5dd7891ecf6151f78e2ac19e6 |
Close
Hashes for kabbes_smart_documentation-0.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09970050794776947447cd02bdf8136e6609099cbc587bd2ee60510b92b18e81 |
|
MD5 | 5e70234b05e16fe6459278f9169d8271 |
|
BLAKE2b-256 | dc30728f5af8a78b455f6a1df1deeeeb6e94ee042ce239327439a86df410acaa |