mkdocstrings
:blue_book: Automatic documentation from sources, for MkDocs. (by pawamoy)
docs
The official Pi-hole documentation (by pi-hole)
Our great sponsors
mkdocstrings | docs | |
---|---|---|
9 | 103 | |
1,572 | 180 | |
3.4% | 5.0% | |
8.4 | 7.7 | |
3 days ago | 1 day ago | |
Python | HTML | |
ISC License | Creative Commons Attribution Share Alike 4.0 |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
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.
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.
mkdocstrings
Posts with mentions or reviews of mkdocstrings.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-01-10.
-
Starlite development updates January ’23
Mkdocs has the mkdocstrings plugin, offering limited automated API documentation capabilities. It is however nowhere near as capable as Sphinx' autodoc, missing granularity in its configuration, limited intersphinx-like cross-referencing support, and essential features like documentation of inherited members, or the ability to manually describe objects if needed.
-
what's a good documentation platform that you guys would recommend?
mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.
-
Stripe Open Sources Markdoc
Author of Materia for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.
[1]: https://mkdocstrings.github.io/
- Mkdocstrings: Automatic Python documentation from sources, for MkDocs
- Technical documentation that just works
-
mkdocstrings: the "autodoc" plugin for MkDocs
Some time has passed since I first introduced mkdocstrings here on reddit. If you don't know what mkdocstrings is: it's the equivalent of the autodoc Sphinx extension, but for MkDocs, a Markdown static site generator. It works differently though, and supports multiple languages by design (not only Python). Someone actually wrote a very good handler for the Crystal language, and another user on GitHub recently expressed their interest for writing one for Go.
-
Python tutorials building large(r) projects
Write proper docstrings as you go along (every time you write a new class/method/function you can document what it’s doing as you’ll know why and what from the pattern you chose). Using a tool like mkdocstrings makes maintaining documentation for larger projects automatic.
-
[Project] mkgendocs - Generating documentation from Python docstrings for MkDocs
I learned of https://github.com/pawamoy/mkdocstrings recently. Is it similar ?
-
Python packages and plugins as namespace packages
A user of mkdocstrings wrote a Crystal handler for their own use-case. They asked on the Gitter channel if we could allow to load external handlers, so they don't have to fork the project and install the fork, but rather just install their lightweight package containing just the handler.
docs
Posts with mentions or reviews of docs.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2024-04-08.
-
Blocky – a DNS proxy and ad-blocker for the local network
It's a DNS proxy, like pi-hole, but it seems a lot more powerful than Pi-hole that is basically just a configured dnsmasq server to be user-friendly.
https://docs.pi-hole.net/
-
Pi hole set up for total beginner
I highly recommend the documentation or this video (which also has a blog) that I followed.
- Any help?? Gravity isn't updating :(
- TV's are becoming intrusive and abusive; what to do about it?
-
Vizio apparently doesn't like cord cutters
Protip: Setup a DNS Sinkhole on your network and you can easily block Vizio and other devices from calling home to update. https://docs.pi-hole.net/
- Will i be able to setup pihole with this settings on my router?
-
No internet access for containers co-hosted with pihole
version: "3" # More info at https://github.com/pi-hole/docker-pi-hole/ and https://docs.pi-hole.net/ networks: dns_net: driver: bridge ipam: config: - subnet: 10.2.0.0/24 services: pihole: depends_on: [unbound] container_name: pihole image: pihole/pihole:latest hostname: pihole networks: dns_net: ipv4_address: 10.2.0.100 ports: - "5335:53/tcp" - "5335:53/udp" - "7000:80/tcp" environment: TZ: ${TZ} WEBPASSWORD: ${PWD} FTLCONF_LOCAL_IPV4: ${HOST_IP} # Set to server's LAN IP, used by web block modes. PIHOLE_DNS_: 10.2.0.200 # Upstream DNS server(s) for Pi-hole to forward queries to, separated by a semicolon DNSMASQ_LISTENING: all # "Listen on all interfaces, permit all origins" # Volumes store your data between container upgrades volumes: - /var/lib/docker/volumes/pihole/etc-pihole:/etc/pihole - /var/lib/docker/volumes/pihole/etc-dnsmasq.d:/etc/dnsmasq.d healthcheck: disable: true restart: unless-stopped unbound: # https://github.com/MatthewVance/unbound-docker container_name: unbound image: mvance/unbound:latest hostname: unbound networks: dns_net: ipv4_address: 10.2.0.200 ports: - "${HOST_IP}:53:53/udp" - "${HOST_IP}:53:53/tcp" healthcheck: disable: true restart: unless-stopped
- 2023 May 8 Stickied -FAQ- & -HELPDESK- thread - Boot problems? Power supply problems? Display problems? Networking problems? Need ideas? Get help with these and other questions!
-
What product was better 10 yrs ago than it is today?
Absolutely. Check out the Pi-Hole documentation here: https://docs.pi-hole.net/
-
Software to monitor Wi-Fi traffic?
See https://docs.pi-hole.net/
What are some alternatives?
When comparing mkdocstrings and docs you can also consider the following projects:
mkdocs-material - Documentation that simply works
sphinx - The Sphinx documentation generator
docker-pi-hole - Pi-hole in a docker container
pydocstyle - docstring style checker
mike - Manage multiple versions of your MkDocs-powered documentation via Git
furo - A clean customizable documentation theme for Sphinx
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
nextdns - NextDNS CLI client (DoH Proxy)
pydantic - Data validation using Python type hints