Show HN: MikeDoc – Neat docstring format for building API references

• mikedoc

  1 2 5.4 Python

  Neat docstring format for building API references

• braq

  6 7 5.6 Python

  Customizable data format for config files, AI prompts, and more

As a neat docstring format, MikeDoc can extend existing documentation generators such as Sphinx and can be used with any programming language that supports concepts such as function parameters, return value, and exceptions.

As a standalone tool, MikeDoc would fit well into any Python project whose API reference needs to be embedded in the root directory and browsable offline and online without config changes.

MikeDoc's Python package is available on PyPI and you can already explore its own API reference on GitHub [5].

Let me know what you think of this project.

[1] https://en.wikipedia.org/wiki/Docstring

[2] https://news.ycombinator.com/item?id=21289832 [Four kinds of documentation (divio.com)]

[3] https://github.com/pyrustic/braq

[4] https://news.ycombinator.com/item?id=38684724

[5] https://github.com/pyrustic/mikedoc/?tab=readme-ov-file#demo

• InfluxDB

  www.influxdata.com featured

  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.

  

Suggest a related project