Skip to content

Commit 9925952

Browse files
samcunliffematt-grahamdstansby
authored
Suggestions from code review.
Co-authored-by: Matt Graham <matthew.m.graham@gmail.com> Co-authored-by: David Stansby <dstansby@gmail.com>
1 parent bff94dd commit 9925952

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/pages/docs.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ layout: default
77

88
With Python, as with many other languages, it's very common to automatically
99
create a web page with documentation built from [docstrings] in your package's
10-
API. For your package to be easily reusable we recommend you build documentation
10+
_application programming interface_ (API). For your package to be easily reusable we recommend you build documentation
1111
pages and host them somewhere.
1212

1313
If you're using GitHub, the simplest is to host your docs on [GitHub pages].
@@ -33,14 +33,14 @@ If you're using GitHub, the simplest is to host your docs on [GitHub pages].
3333
<summary>More details about Sphinx</summary>
3434

3535
We marginally recommend [MkDocs] over [Sphinx] due to it's ease of use,
36-
preference for markdown, and slightly better support of our preferred docstring
36+
preference for Markdown, and slightly better support of our preferred docstring
3737
style.
3838

39-
However the [Sphinx] tool has long been the de-facto standard, it is widely
39+
However the [Sphinx] tool has long been the de-facto standard in the scientific Python ecosystem. It is widely
4040
used, customisable, and well tested. If you need a [Sphinx
4141
extension](#sphinx-extensions) that does not have an equivalent [MkDocs
4242
plugin](https://github.com/mkdocs/catalog), or if you are part of a community
43-
that heavily uses [Sphinx] then, as with all tools, we recommend you use that
43+
that heavily uses [Sphinx] then we recommend you use that
4444
instead.
4545

4646
### See also

0 commit comments

Comments
 (0)