docs VS mkdocstrings

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/

I highly recommend the documentation or this video (which also has a blog) that I followed.

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/

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

Absolutely. Check out the Pi-Hole documentation here: https://docs.pi-hole.net/

See https://docs.pi-hole.net/

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.

mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.

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/

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.

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.

I learned of https://github.com/pawamoy/mkdocstrings recently. Is it similar ?

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.