@@ -73,7 +73,7 @@ which some users find harder to use.
73
73
__ Advantages__
74
74
75
75
- Very powerful, customizable and extendable
76
- - Generates reference documentation from [ Python Docstrings ]
76
+ - Generates reference documentation from [ Python docstrings ]
77
77
- Large and rich ecosystem, used by many Python projects
78
78
79
79
__ Challenges__
@@ -82,20 +82,14 @@ __Challenges__
82
82
- Search is less powerful than the one provided by MkDocs
83
83
- More time needed to get up and running
84
84
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.
94
89
95
90
[ Sphinx ] : https://www.sphinx-doc.org/
96
91
[ 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/
99
93
[ Furo ] : https://pradyunsg.me/furo/
100
94
[ mkdocstrings ] : https://github.com/mkdocstrings/mkdocstrings
101
95
0 commit comments