Skip to content

Commit 777bab1

Browse files
Samreayhenryiii
authored andcommitted
Updating copier
1 parent d61709a commit 777bab1

3 files changed

Lines changed: 24 additions & 4 deletions

File tree

cookiecutter.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
"docs": {
5050
"__prompt__": "Chose your documentation tool",
5151
"sphinx": "Sphinx",
52-
"mkdocs": "mkdocs-material"
52+
"mkdocs": "MkDocs"
5353
},
5454
"vcs": "Use version control for versioning"
5555
}

copier.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ backend:
8282
"Maturin - Compiled Rust (recommended)": maturin
8383
# [[[end]]]
8484

85+
# [[[cog print(cc.docs.yaml()) ]]]
86+
backend:
87+
help: Choose your documentation tool
88+
choices:
89+
"Sphinx": sphinx
90+
"MkDocs": mkdocs
91+
# [[[end]]]
92+
8593
# [[[cog print(cc.vcs.yaml()) ]]]
8694
vcs:
8795
type: bool

docs/pages/tutorials/docs.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,18 @@ Some **bold** or _italicized_ text!
3434
This documentation "source code" is then _built_ into a formats like HTML or PDF
3535
to 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
4049
documentation for more information on the Markdown syntax in general and MyST's
4150
flavor 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

Comments
 (0)