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.5.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.5.1-py3-none-any.whl (16.0 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esp_docs-2.5.1.tar.gz
Algorithm Hash digest
SHA256 f25dbde5876fa64a0fd7513b88280f627f0d07882217ad7f6c9e902c4ea97521
MD5 f8497b435d0d80265a1587935f5d3355
BLAKE2b-256 a4101680915560fa6abe952904f6c0d885a5ff004428b6dd7c6e09efc8e402bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for esp_docs-2.5.1.tar.gz:

Publisher: release_pypi.yml on espressif/esp-docs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

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

File hashes

Hashes for esp_docs-2.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 99a2b0227845ff393496d59e0ba65f3d6abb403224cb391d7a848fc30b275f55
MD5 a48fe918329c089ad70a2e799ba353c4
BLAKE2b-256 2cd823c172a310ce1f5c2f1640347be0d5a9434c926328c585b6e11cc1eb4ed5

See more details on using hashes here.

Provenance

The following attestation bundles were made for esp_docs-2.5.1-py3-none-any.whl:

Publisher: release_pypi.yml on espressif/esp-docs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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