@@ -7,7 +7,7 @@ layout: default
7
7
8
8
With Python, as with many other languages, it's very common to automatically
9
9
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
11
11
pages and host them somewhere.
12
12
13
13
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].
33
33
<summary >More details about Sphinx</summary >
34
34
35
35
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
37
37
style.
38
38
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
40
40
used, customisable, and well tested. If you need a [ Sphinx
41
41
extension] ( #sphinx-extensions ) that does not have an equivalent [ MkDocs
42
42
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
44
44
instead.
45
45
46
46
### See also
0 commit comments