Merge similar documentation pages

docs/dev/build_docs.md

-# Documentation development
-
-## Setup
-
-Add the `docs` extra when installing `teklia-dan`:
-
-```sh
-# In a clone of the Git repository
-pip install .[docs]
-```
-
-Build the documentation using `mkdocs serve -v`. The documentation should be available as http://localhost:8000
-
-## Writing documentation
-
-This documentation uses [Sphinx](http://www.sphinx-doc.org/) and was generated using [mkdocs](https://mkdocs.org/) and [mkdocstrings](https://mkdocstrings.github.io/).
-
-## Linting
-
-This documentation is subject to linting using `doc8`, integrated into
-`pre-commit`. You can run it locally by typing `pre-commit run`. You should use
-`pre-commit install` to have the pre-commit hook run before each Git commit.
-
-The linting rules that `doc8` applies can be found on [its documentation][1].
-
-[1]: https://doc8.readthedocs.io/en/latest/readme.html#usage

docs/get_started/development.md

@@ -24,13 +24,27 @@ tox
 
 To recreate tox virtual environment (e.g. a dependencies update), you may run `tox -r`.
 
-## Update documentation
+## Documentation
 
-Documentation is built with [MkDocs](https://www.mkdocs.org/).
+This documentation uses [Sphinx](http://www.sphinx-doc.org/) and was generated using [MkDocs](https://mkdocs.org/) and [mkdocstrings](https://mkdocstrings.github.io/).
+
+### Setup
+
+Add the `docs` extra when installing `teklia-dan`:
 
 ```shell
-pip install -r doc-requirements.txt
-mkdocs serve
+# In a clone of the Git repository
+pip install .[docs]
 ```
 
-You can then write in Markdown in the relevant `docs/*.md` files, and see live output on http://localhost:8000.
+Build the documentation using `mkdocs serve -v`. You can then write in [Markdown](https://www.markdownguide.org/) in the relevant `docs/*.md` files, and see live output on http://localhost:8000.
+
+### Linter
+
+This documentation is subject to linting using:
+
+- `doc8`, the linting rules applied can be found on [its documentation][1],
+- `mdformat`, the formatting rules applied can be found on [its documentation][2].
+
+[1]: https://doc8.readthedocs.io/en/latest/readme.html#usage
+[2]: https://mdformat.readthedocs.io/en/stable/users/style.html

mkdocs.yml

@@ -69,7 +69,6 @@ nav:
       - Data augmentation: usage/train/augmentation.md
       - Jean Zay tutorial: usage/train/jeanzay.md
     - Predict: usage/predict.md
-  - Documentation development: dev/build_docs.md
   - Python Reference:
     - Datasets:
       - ref/datasets/index.md