@@ -10,14 +10,14 @@ the same format used by GitHub, Wikipedia, and others. This guide covers Sphinx
1010and Mkdocs, and uses the modern MyST plugin to get Markdown support.
1111
1212:::{note} Popular frameworks
13- There are other frameworks as well; these often are simpler, but are not as
14- commonly used, and have somewhat fewer examples and plugins. They are:
13+ The two frameworks covered in this guide are the most commonly used in the
14+ scientific Python community. The main options are:
1515
1616- [ Sphinx] ( https://www.sphinx-doc.org/en/master/ ) : A popular documentation
1717 framework for scientific libraries with a history of close usage with
1818 scientific tools like LaTeX. Examples include
1919 [ astropy] ( https://docs.astropy.org/en/stable/index_user_docs.html ) and
20- [ corner] ( https://docs.astropy.org/en/stable/index_user_docs.html ) .
20+ [ corner] ( https://corner.readthedocs.io ) .
2121- [ MkDocs] ( https://www.mkdocs.org ) : A from-scratch new documentation system
2222 based on markdown and HTML. Less support for man pages & PDFs than Sphinx,
2323 since it doesn't use docutils. Has over
@@ -197,7 +197,7 @@ several good extensions:
197197- [ ` sphinx.ext.napoleon ` ] [ ] adds support for several common documentation styles
198198 like numpydoc.
199199- ` sphinx_autodoc_typehints ` handles type hints
200- - ` sphinx_copybutton ` adds a handle little copy button to code snipits .
200+ - ` sphinx_copybutton ` adds a handy little copy button to code snippets .
201201
202202We are including both possible file extensions. We are also avoiding some common
203203file patterns, just in case.
@@ -602,9 +602,9 @@ some conditional installs based on arguments (sphinx-autobuild is only needed if
602602serving). It does an editable install of your package so that you can skip the
603603install steps with `-R` and still get updated documentation.
604604
605- Then there's a dedicated handler for the 'linkcheck' builder, which just checks
606- links, and doesn't really produce output . Finally, we collect some useful args,
607- and run either the autobuild (for `--serve` ) or regular build. We could have
605+ The `-b` argument selects the builder, so you can pass `-b linkcheck` to just
606+ check links, for example . Finally, we collect some useful args, and run either
607+ the autobuild (when interactive ) or a regular build. We could have
608608just added `python -m http.server` pointing at the built documentation, but
609609autobuild will rebuild if you change a file while serving.
610610:: :
0 commit comments