- Generate HTML documentation in `public` directory:
```bash
poetry run make docs
poetry run sphinx-apidoc -o docs .
poetry run sphinx-build -b html docs public
```
- The HTML documentation is generated in `docs/_build/html` folder.
## Development
* When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features
* Use `make` commands to check the code and the format.
* Use `pre-commit run --all-files` commands to check the code and the format.
* Install runtime dependencies
```bash
...
...
@@ -108,7 +107,7 @@ poetry install
* Check static typing with [mypy](http://mypy-lang.org/)
```bash
make check
pre-commit run -a mypy
```
## Packaging and deploy
...
...
@@ -120,12 +119,13 @@ Change and commit and tag the new version number (semantic version number)
Build the PyPI package in the `dist` folder
```bash
make build
poetry build
```
Deploy the package to PyPI test repository (prefix the command with a space for the shell to not save it in its history system, since the command contains credentials)
Deploy the package on the PyPI repository (prefix the command with a space for the shell to not save it in its history system, since the command contains credentials)