mike
furo
Our great sponsors
| mike | furo | |
|---|---|---|
| 2 | 7 | |
| 467 | 2,454 | |
| - | - | |
| 7.4 | 8.5 | |
| 25 days ago | 6 days ago | |
| Python | Sass | |
| BSD 3-clause "New" or "Revised" License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
mike
-
where do you host your embedded docs?
I use MkDocs for generating the documentation website (using the Material theme) and host in on GitHub pages. For managing and hosting multiple versions, I use the Mike extension for MkDocs.
-
Technical documentation that just works
Thanks. This is an alternative vision compared with what I am doing, but it seems better. Especially the C4 model as basic philosophy, and then the supporting technology.
Pleas blog about this, it is very interesting to me.
Just to be sure: this is what you mean with Mike?
https://github.com/jimporter/mike
furo
-
Can someone help me understand "documentation generators" and the purpose of Sphinx?
Sphinx has more and in my opinion better themes (especially the popular Furo them). I also think it's better for handling large and complex sites. It's way more extensible. That there are far more Sphinx users means that you're more likely to have community support if/when you run into issues.
-
Can you select themes for rustdoc?
My company uses sphinx, in particular the furo theme: https://github.com/pradyunsg/furo. I'd like to use something like this to start documenting our Rust repositories. Is this possible on stable?
-
[D] What JAX NN library to use?
On another note, what did you dislike in Sphinx ? I found it pretty easy to work with until now and there are quite nice themes, like Furo (https://github.com/pradyunsg/furo), which is actually pretty similar to your current docs theme. I used it recently for one of my projects (see https://francois-rozet.github.io/piqa/piqa.psnr.html).
-
New Sphinx theme
reminds me a lot of Furo which is used by big names such as urllib3, pip, attrs, psycopg3, black
- Furo: A clean customizable documentation theme for Sphinx
- Technical documentation that just works
-
Furo – A clean customizable documentation theme for Sphinx
This theme was created by one of the maintainers of pip, which is where I first saw it (https://pip.pypa.io/en/stable/). Here are some of the things I like about it:
- Well-chosen, proportionate font sizes and spacing.
- Table of contents sidebars for both the current page and the whole documentation site.
- Fully responsive: sidebars disappear in narrow windows or small screens, but can still be popped out.
- Clean color scheme with good contrast, and full support for dark mode (see screenshot at https://github.com/pradyunsg/furo/blob/main/README.md).
What are some alternatives?
mkdocs-material - Documentation that simply works
docs - The official Pi-hole documentation
sphinx - The Sphinx documentation generator
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
autokeras - AutoML library for deep learning
vscode-theme-alabaster-dark - Dark version of alabaster ported from https://github.com/tonsky/sublime-scheme-alabaster
kotlin4example - Literate programming for Kotlin. Write markdown based documentation for your kotlin project with working examples.
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
PVEDiscordDark - A Discord-like dark theme for the Proxmox Web UI.