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.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b22d8011837419e46530d170dbead955e9b618b8ea3b8b00827d32530f92febe |
|
MD5 | a719530f9f5d744846c83fa1e898885f |
|
BLAKE2b-256 | 0b924413edfab4a009129c136f6531c7e7ad46a5676ec72d7f9826fc7c5eb8f0 |
Close
Hashes for kabbes_smart_documentation-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8eac0f92f1450b9ec3e8a31516fe07c90b4716a87cca6dec25de4776619465be |
|
MD5 | 2b7cf36421f1998ef6083bd7f193f984 |
|
BLAKE2b-256 | 2d9f3b89726e417a2fb33024dfb676074e8c1b66a1e5ace4bd0e1a3c859d270d |