Metadata-Version: 2.1
Name: packagename-jarne
Version: 0.3.0
Summary: Example project for sphinx python.
Home-page: https://github.com/jarneamerlinck/python-sphinx-documentation
Author: Jarne Amerlinck
Author-email: jarneamerlinck@gmail.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.9.2
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: psutil
Provides-Extra: docs
Requires-Dist: Sphinx (>=6.1.3) ; extra == 'docs'
Requires-Dist: sphinx-markdown-builder (>=0.5.5) ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints (>=1.22) ; extra == 'docs'
Requires-Dist: sphinx-press-theme (>=0.8.0) ; extra == 'docs'
Requires-Dist: sphinx-favicon ; extra == 'docs'
Requires-Dist: twine ; extra == 'docs'
Requires-Dist: graphviz ; extra == 'docs'


# Python-sphinx-documentation

Template to document code with sphinx.
install package ```pip install packagename_jarne```

## Create documentation

1. 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


1. Install package with conda

```conda env create -f environment.yml```

2. 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

1. Add files in package folder ```packagename_jarne``` (or the new name)
2. Add links to the python files in ```docs/source/```
3. Make [Documentation](#create-documentation) (see above)

## Upload to pipy requirements

- add ```PYPI_TOKEN``` to github secrets
