Description:

packagenamejarne 0.3.0

Python-sphinx-documentation
Template to document code with sphinx.
install package pip install packagename_jarne
Create documentation

Update files to fit the new package


Change packagename_jarne to the new packagename
Change version in packagename_jarne/version
Update setup.py
Update sources for Sphinx

docs/source/conf.py
rst files




Install package with conda

conda env create -f environment.yml

Make documentation


conda env create -f environment_build.yml; conda activate conda-env-name-build;cd docs;make html;cd ..
make html

alternatives make help



Add new python files

Add files in package folder packagename_jarne (or the new name)
Add links to the python files in docs/source/
Make Documentation (see above)

Upload to pipy requirements

add PYPI_TOKEN to github secrets

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter