OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-05-12 08:28:28 +02:00
parent 77386854ef
commit 3ee031382b
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/alternatives.md
View File

@ -73,7 +73,7 @@ which some users find harder to use.
__Advantages__
- Very powerful, customizable and extendable
- Generates reference documentation from [Python Docstrings]
- Generates reference documentation from [Python docstrings]
- Large and rich ecosystem, used by many Python projects
__Challenges__
@ -82,20 +82,14 @@ __Challenges__
- Search is less powerful than the one provided by MkDocs
- More time needed to get up and running
If you want to chose Sphinx over MkDocs, you might want to check out
[Immaterial], an actively maintained Sphinx port of Material for MkDocs.
However, be warned that the search experience is pretty far from what Material
for MkDocs offers, mainly due to limitations of Sphinx.
If you want the best of both worlds, you should give [mkdocstrings] a try – a
popular framework building on top of MkDocs that generates documentation from
sources, similar to what Sphinx offers. The project is still young, but already
closed many gaps between MkDocs and Sphinx.
If you're considering using Sphinx because you need to generate reference
documentation, you should give [mkdocstrings] a try – an actively maintained
and popular framework building on top of MkDocs, implementing Sphinx-like
functionality.
[Sphinx]: https://www.sphinx-doc.org/
[reStructured text]: https://en.wikipedia.org/wiki/ReStructuredText
[Python Docstrings]: https://www.python.org/dev/peps/pep-0257/
[Immaterial]: https://github.com/jbms/sphinx-immaterial
[Python docstrings]: https://www.python.org/dev/peps/pep-0257/
[Furo]: https://pradyunsg.me/furo/
[mkdocstrings]: https://github.com/mkdocstrings/mkdocstrings