@@ -34,9 +34,18 @@ Some **bold** or _italicized_ text!
3434This documentation "source code" is then _ built_ into a formats like HTML or PDF
3535to be displayed to the user.
3636
37- There are a variety of tools that can do this. In this guide we will present an
38- approach that is mainstream in the scientific Python community: the [ Sphinx] [ ]
39- documentation generator with the [ MyST] [ ] plugin. Refer to the MyST
37+ There are a variety of tools that can do this. In this guide we will present two approaches that are mainstream in
38+ the scientific Python community: the [ Sphinx] [ ]
39+ documentation generator with the [ MyST] [ ] plugin, and the [ MkDocs] [ ] generator
40+ via [ mkdocs-material] [ ] .
41+
42+ For more details, examples to help you pick between Sphinx and MkDocs (and instructions for the latter),
43+ see the [ documentation guide] [ ] . For this simple introduction, we will use Sphinx as it is still
44+ more popular with scientific libraries, even though MkDocs is simpler to set up and more popular in
45+ general with Python documentation.
46+
47+
48+ Please refer to the MyST
4049documentation for more information on the Markdown syntax in general and MyST's
4150flavor of Markdown in particular.
4251
@@ -202,4 +211,7 @@ integrate this into a package, and setup for nox.
202211[ myst ] : https://myst-parser.readthedocs.io/
203212[ organizing content ] : https://myst-parser.readthedocs.io/en/latest/syntax/organising_content.html
204213[ sphinx-autodoc2 ] : https://sphinx-autodoc2.readthedocs.io/
214+ [ mkdocs ] : https://www.mkdocs.org/
215+ [ mkdocs-material ] : https://squidfunk.github.io/mkdocs-material/
216+ [ documentation guide] : {% link pages/guides/docs.md %}
205217<!-- prettier-ignore-end -->
0 commit comments