Skip to content

Commit

Permalink
Reword until we've decided our recommended docstring style.
Browse files Browse the repository at this point in the history
  • Loading branch information
samcunliffe committed Mar 25, 2024
1 parent 26c1e5b commit bcab7cc
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/pages/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ If you're using GitHub, one option is to host your docs on [GitHub pages].
<summary>More details about Sphinx</summary>

We marginally recommend [MkDocs] over [Sphinx] due to it's ease of use,
preference for Markdown, and slightly better support of our preferred docstring
style.
preference for Markdown, and more support for a variety of docstring styles.

However the [Sphinx] tool has long been the de-facto standard in the scientific Python ecosystem. It is widely
used, customisable, and well tested. If you need a [Sphinx
Expand Down

0 comments on commit bcab7cc

Please sign in to comment.