Skip to content

Commit 3ee0313

Browse files
committed
Documentation
1 parent 7738685 commit 3ee0313

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

docs/alternatives.md

+6-12
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ which some users find harder to use.
7373
__Advantages__
7474

7575
- Very powerful, customizable and extendable
76-
- Generates reference documentation from [Python Docstrings]
76+
- Generates reference documentation from [Python docstrings]
7777
- Large and rich ecosystem, used by many Python projects
7878

7979
__Challenges__
@@ -82,20 +82,14 @@ __Challenges__
8282
- Search is less powerful than the one provided by MkDocs
8383
- More time needed to get up and running
8484

85-
If you want to chose Sphinx over MkDocs, you might want to check out
86-
[Immaterial], an actively maintained Sphinx port of Material for MkDocs.
87-
However, be warned that the search experience is pretty far from what Material
88-
for MkDocs offers, mainly due to limitations of Sphinx.
89-
90-
If you want the best of both worlds, you should give [mkdocstrings] a try – a
91-
popular framework building on top of MkDocs that generates documentation from
92-
sources, similar to what Sphinx offers. The project is still young, but already
93-
closed many gaps between MkDocs and Sphinx.
85+
If you're considering using Sphinx because you need to generate reference
86+
documentation, you should give [mkdocstrings] a try – an actively maintained
87+
and popular framework building on top of MkDocs, implementing Sphinx-like
88+
functionality.
9489

9590
[Sphinx]: https://www.sphinx-doc.org/
9691
[reStructured text]: https://en.wikipedia.org/wiki/ReStructuredText
97-
[Python Docstrings]: https://www.python.org/dev/peps/pep-0257/
98-
[Immaterial]: https://github.com/jbms/sphinx-immaterial
92+
[Python docstrings]: https://www.python.org/dev/peps/pep-0257/
9993
[Furo]: https://pradyunsg.me/furo/
10094
[mkdocstrings]: https://github.com/mkdocstrings/mkdocstrings
10195

0 commit comments

Comments
 (0)