Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update theme-related text in documentation guide #437

Merged
merged 7 commits into from
Jun 10, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/pages/guides/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ parent: Topical Guides
# Writing documentation

Documentation used to require learning reStructuredText (sometimes referred to
as reST / RST), but today we have great choices for documentation in markdown,
as reST / rST), but today we have great choices for documentation in markdown,
henryiii marked this conversation as resolved.
Show resolved Hide resolved
the same format used by GitHub, Wikipedia, and others. This guide covers Sphinx,
and uses the modern MyST plugin to get Markdown support.

Expand All @@ -29,7 +29,7 @@ and uses the modern MyST plugin to get Markdown support.
> based on markdown and HTML. Less support for man pages & PDFs than Sphinx,
> since it doesn't use docutils. Has over
> [200 plugins](https://github.com/mkdocs/catalog) - they are much easier to
> write than Sphinx. Examples include [hatch](https://hatch.pypa.io),
> write than Sphinx. Example sites include [hatch](https://hatch.pypa.io),
henryiii marked this conversation as resolved.
Show resolved Hide resolved
> [PDM](https://pdm.fming.dev),
> [cibuildwheel](https://cibuildwheel.readthedocs.io),
> [Textual](https://textual.textualize.io), and
Expand Down Expand Up @@ -147,9 +147,10 @@ several good extensions:
We are including both possible file extensions. We are also avoiding some common
file patterns, just in case.

For theme, you have several good options. The clean, light-weight Furo theme is
shown above. Many scientific packages choose the `sphinx-py-data` theme, which
is also a good choice (no dark mode, though).
For theme, many scientific packages choose the
[pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/). The
[Furo theme](https://pradyunsg.me/furo/) is another popular choice. The site
[sphinx-themes.org](https://sphinx-themes.org/) can be used to compare options.
drammock marked this conversation as resolved.
Show resolved Hide resolved

We are enabling a useful MyST extension: `colon_fence` allows you to use three
colons for directives, which might be highlighted better if the directive
Expand Down