21 tools to document your Python project

1. slate

   1 21 36,148 3.4 SCSS

   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.

2. Stream

   getstream.io featured

   Stream - Scalable APIs for Chat, Feeds, Moderation, & Video. Stream helps developers build engaging apps that scale to millions with performant and flexible Chat, Feeds, Moderation, and Video APIs and SDKs powered by a global edge network and enterprise-grade infrastructure.

   

3. swagger-ui

   2 158 27,893 9.3 JavaScript

   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.

4. redoc

   3 40 24,639 7.6 TypeScript

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

5. apispec

   4 1 1,199 7.6 Python

   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.

6. mkdocs

   5 1 - -

   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.

7. django-rest-framework

   6 209 29,280 8.3 Python

   Web APIs for Django. 🎸

   

   Django-REST-Framework

8. Read the Docs

   7 36 8,209 9.8 Python

   The source code that powers readthedocs.org

   

   Read the Docs

9. InfluxDB

   www.influxdata.com featured

   InfluxDB – Built for High-Performance Time Series Workloads. InfluxDB 3 OSS is now GA. Transform, enrich, and act on time series data directly in the database. Automate critical tasks and eliminate the need to move data externally. Download now.

   

10. Next.js

    8 2,360 133,051 10.0 JavaScript

    The React Framework

    

    Next.js

11. Hugo

    9 593 82,212 9.8 Go

    The world’s fastest framework for building websites.

    

    Hugo

Suggest a related project