Skip to main content

Documentation building package used at Espressif

Project description

Espressif Documentation Build System

Esp-docs is a python based wrapper for the documentation building package Sphinx.

It is intended to simplify and extend Sphinx's functionality to better suit what is needed for building documentation for Espressif's development frameworks

Provides:

  • Functionality for building documentation for multiple targets (e.g. ESP32 and ESP32-C3) from the same rst source files.
  • Sphinx extensions used at Espressif
  • Scripts for deploying docs

For a more in-depth guide on how to install, write, and compile documentation please see ESP-Docs User Guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

esp_docs-2.1.1.tar.gz (15.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

esp_docs-2.1.1-py3-none-any.whl (16.0 MB view details)

Uploaded Python 3

File details

Details for the file esp_docs-2.1.1.tar.gz.

File metadata

  • Download URL: esp_docs-2.1.1.tar.gz
  • Upload date:
  • Size: 15.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for esp_docs-2.1.1.tar.gz
Algorithm Hash digest
SHA256 fce3858473f168a03a650bbe1d36bbad82fad5b72c500ba9d127f158dc025af3
MD5 2b9eacdf31d6cb7080adf14849d2ce10
BLAKE2b-256 49b4087d2b40fe39dad2ebeb7a73c90f9fb3a310136f47f563b9d83f7b4f87d5

See more details on using hashes here.

File details

Details for the file esp_docs-2.1.1-py3-none-any.whl.

File metadata

  • Download URL: esp_docs-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 16.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for esp_docs-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7b20abdb880f31b9e40e586e64272181f8f839fcf0381ef7a0f135cf4948ce72
MD5 96f3b59a87ec5850c219f0191f3dbf28
BLAKE2b-256 aaafec5bd46b0d3f8ac49321dfc4d723437ee1ff4c29ca590a6578c38c98a09d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page