21 tools to document your Python project

This page summarizes the projects mentioned and recommended in the original post on dev.to

Scout Monitoring - Free Django app performance insights with Scout Monitoring
Get Scout setup in minutes, and let us sweat the small stuff. A couple lines in settings.py is all you need to start monitoring your apps. Sign up for our free tier today.
www.scoutapm.com
featured
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.
www.influxdata.com
featured
  • slate

    Beautiful static documentation for your API

  • Slate and friends. The next step towards a more controlled evolution of the API documentation is a tool like Slate and the API documentation in git. It's still text that you need to write manually in Markdown, but Slate provides a structure, a slick renderer, and lets you publish your API as an independent website.

  • Scout Monitoring

    Free Django app performance insights with Scout Monitoring. Get Scout setup in minutes, and let us sweat the small stuff. A couple lines in settings.py is all you need to start monitoring your apps. Sign up for our free tier today.

    Scout Monitoring logo
  • swagger-ui

    Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

  • If you installed an IDE extension, you don't need to install anything else. All extensions come with a command opening the Swagger UI right in the editor window: that's what you've just seen in the previous screenshots. If you want to install it, though, you can find all the different options in their installation instructions.

  • redoc

    📘 OpenAPI/Swagger-generated API Reference Documentation

  • ReDoc supports extra fields to your attributes, so-called (vendor extensions)[https://github.com/Redocly/redoc#swagger-vendor-extensions]. These fields provide more options to control how to render the documentation. For example, you can add a key x-codeSamples to your request specs and provide code samples in different programming languages. If you want something similar to Slate but generated automatically, that's probably the closest you can get.

  • apispec

    A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..

  • apispec is not a framework, but a library that provides a Pythonic interface to OpenAPI constructs. It has multiple integrations with different tools and frameworks, including Flask, Pyramid, aiohttp, and Falcon. The list of integrations is available on the ecosystem page.

  • mkdocs

  • Gitlab pages provides the same functionality, but unlike GitHub, private websites are available even on the free account. There is a Gitlab group pages with examples of projects sharing documentation, including mkdocs, Sphinx, among dozens of others.

  • django-rest-framework

    Web APIs for Django. 🎸

  • Django-REST-Framework

  • Read the Docs

    The source code that powers readthedocs.org

  • Read the Docs

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

    The React Framework

  • Next.js

  • Hugo

    The world’s fastest framework for building websites.

  • Hugo

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

  • Killed by open sourced software. Companies that have had a significant market share stolen from open sourced alternatives.

    3 projects | /r/opensource | 11 Dec 2023
  • It's Christmas day. You wake up, run to the tree, tear open the largest package with your name on it... FastAPI has added _____?

    4 projects | /r/Python | 6 Dec 2023
  • Faster time-to-market with API-first

    12 projects | dev.to | 25 Oct 2022
  • what popular wabsites uses Flask and Django and what popular companies uses Python?

    3 projects | /r/learnpython | 11 Jun 2022
  • Flask vs FastAPI?

    11 projects | /r/Python | 6 May 2022