Skip to content

Commit eab1b31

Browse files
committed
Documentation
1 parent 8beda2b commit eab1b31

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/alternatives.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,20 @@ __Challenges__
8282
- Search is less powerful than the one provided by MkDocs
8383
- More time needed to get up and running
8484

85-
[Sphinx Immaterial] is a great port of Material for MkDocs to Sphinx, as it
86-
follows the upstream repository closely. [Furo] is another great theme.
87-
Alternatively, [mkdocstrings] builds on top of MkDocs to allow
88-
the generation of reference documentation.
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.
8994

9095
[Sphinx]: https://www.sphinx-doc.org/
9196
[reStructured text]: https://en.wikipedia.org/wiki/ReStructuredText
9297
[Python Docstrings]: https://www.python.org/dev/peps/pep-0257/
93-
[Sphinx Immaterial]: https://github.com/jbms/sphinx-immaterial
98+
[Immaterial]: https://github.com/jbms/sphinx-immaterial
9499
[Furo]: https://pradyunsg.me/furo/
95100
[mkdocstrings]: https://github.com/mkdocstrings/mkdocstrings
96101

0 commit comments

Comments
 (0)