21 tools to document your Python project

• slate

  21 35,827 4.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.

• swagger-ui

  131 25,507 9.8 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.

• InfluxDB

  www.influxdata.com sponsored

  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.

  

• redoc

  35 22,462 7.5 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.

• apispec

  1 1,134 8.3 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.

• mkdocs

  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.

• django-rest-framework

  197 27,489 8.7 Python

  Web APIs for Django. 🎸

  

Django-REST-Framework

• Read the Docs

  33 7,870 9.7 Python

  The source code that powers readthedocs.org

  

Read the Docs

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• Next.js

  2,041 120,572 10.0 JavaScript

  The React Framework

  

Next.js

• Hugo

  548 72,452 9.8 Go

  The world’s fastest framework for building websites.

  

Hugo

Suggest a related project