Skip to content
Snippets Groups Projects
Commit 078871a7 authored by Moul's avatar Moul
Browse files

[doc] #165: Readme: Update make commands accordingly

parent 12f63c5f
No related branches found
No related tags found
1 merge request!170#165, #182: Stop using the Makefile in the CI and tools installed from Poetry dev dependencies in favor of pre-commit, Bump Sphinx to v4
Pipeline #14324 waiting for manual action
...@@ -83,16 +83,14 @@ poetry run python ...@@ -83,16 +83,14 @@ poetry run python
poetry install poetry install
``` ```
- Generate documentation - Generate HTML documentation in `public` directory:
```bash ```bash
poetry run make docs make docs
``` ```
- The HTML documentation is generated in `docs/_build/html` folder.
## Development ## Development
* When writing docstrings, use the reStructuredText format recommended by https://www.python.org/dev/peps/pep-0287/#docstring-significant-features * 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 `make check` commands to check the code and the format.
* Install runtime dependencies * Install runtime dependencies
```bash ```bash
...@@ -108,7 +106,7 @@ poetry install ...@@ -108,7 +106,7 @@ poetry install
* Check static typing with [mypy](http://mypy-lang.org/) * Check static typing with [mypy](http://mypy-lang.org/)
```bash ```bash
make check make mypy
``` ```
## Packaging and deploy ## Packaging and deploy
...@@ -123,9 +121,9 @@ Build the PyPI package in the `dist` folder ...@@ -123,9 +121,9 @@ Build the PyPI package in the `dist` folder
make build make 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 to PyPI test repository:
```bash ```bash
[SPACE]make deploy_test PYPI_TEST_LOGIN=xxxx PYPI_TEST_PASSWORD=xxxx make deploy_test
``` ```
Install the package from PyPI test repository Install the package from PyPI test repository
...@@ -133,9 +131,9 @@ Install the package from PyPI test repository ...@@ -133,9 +131,9 @@ Install the package from PyPI test repository
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.python.org/simple/ duniterpy pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.python.org/simple/ duniterpy
``` ```
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) Deploy the package on the PyPI repository:
```bash ```bash
[SPACE]make deploy PYPI_LOGIN=xxxx PYPI_PASSWORD=xxxx make deploy
``` ```
## Packaging status ## Packaging status
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment