what's a good documentation platform that you guys would recommend?

This page summarizes the projects mentioned and recommended in the original post on /r/Python

Our great sponsors
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • WorkOS - The modern identity platform for B2B SaaS
  • SaaSHub - Software Alternatives and Reviews
  • pdoc

    API Documentation for Python Projects

  • 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

  • Docusaurus

    Easy to maintain open source documentation websites.

  • Does it need to be Python related? If not, take a look at Docusarus.

  • 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.

    InfluxDB logo
  • devdocs

    API Documentation Browser

  • mkdocstrings

    :blue_book: Automatic documentation from sources, for MkDocs.

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

  • mkdocs-render-swagger-plugin

    A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI.

  • 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.

  • pdoc

    :snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects (by pdoc3)

  • Seems like that is actually a Hindu symbol? Anyways, relevant controversy here: https://github.com/pdoc3/pdoc/issues/346

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts