Our great sponsors
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
mkdocs-render-swagger-plugin
A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI.
I’ve used sphinx extensively and though it is one of the standards and does a ton, I do not like or recommend it. Personally, I realllly like pdoc for its simplicity. Do not confused pdoc with pdoc3
Does it need to be Python related? If not, take a look at Docusarus.
mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.
I tried out this plugin a few months ago: https://github.com/bharel/mkdocs-render-swagger-plugin At the time it was very new, had a few issues, and I was on a horrible deadline. But I plan to revisit it.
Seems like that is actually a Hindu symbol? Anyways, relevant controversy here: https://github.com/pdoc3/pdoc/issues/346
Related posts
- What is it that makes Rust documentation so special, and how could we make that lightning strike twice in other languages?
- Bombsquad 1.6.11 (20538, 2022-03-23) released
- My first open-source package on PyPI: `spectrumdevice`, a high-level, object-oriented library for controlling Spectrum Instruments digitisers. A bit of a niche one!
- Show HN: Pdoc, a lightweight Python API documentation generator
- Show HN: Pdoc, a lightweight Python API documentation generator