From e637b82e6a35313247665b940e303325f29001ac Mon Sep 17 00:00:00 2001
From: Moul <moul@moul.re>
Date: Tue, 7 Dec 2021 18:28:33 +0100
Subject: [PATCH] [doc] #165: Readme: change make commands with poetry,
 pre-commit, sphinx* commands

Switch to 'poetry deploy' prompting for PyPI credentials
---
 README.md | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index aa71f20b..8f5a7042 100644
--- a/README.md
+++ b/README.md
@@ -83,16 +83,15 @@ poetry run python
 poetry install
 ```
 
-- Generate documentation
+- 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 to PyPI test repository:
 ```bash
-[SPACE]make deploy_test PYPI_TEST_LOGIN=xxxx PYPI_TEST_PASSWORD=xxxx
+poetry config repositories.pypi_test https://test.pypi.org/legacy/
+poetry publish --build --repository pypi_test
 ```
 
 Install the package from PyPI test repository
@@ -133,9 +133,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
 ```
 
-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
-[SPACE]make deploy PYPI_LOGIN=xxxx PYPI_PASSWORD=xxxx
+poetry publish --build
 ```
 
 ## Packaging status
-- 
GitLab