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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esp_docs-2.4.0.tar.gz
Algorithm Hash digest
SHA256 9fe6287fd7e0d596012737621006f8ff69e41fbff2c5ae910a2c48b64b6eb27a
MD5 6594527220e4ca53902a2c6d18c48e0c
BLAKE2b-256 bde1f6f3265345599e11d903f85c61a082b7b1049c37ad01bc3688bc41fcd8c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for esp_docs-2.4.0.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: esp_docs-2.4.0-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.7

File hashes

Hashes for esp_docs-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f249f1f2c7bd02c76e4172610254358df5737b759b001fc4fd7150a67aa3c8a3
MD5 16d8b6ab5ccea187223b4f6fc3bb7bb5
BLAKE2b-256 6d14cdb1d1b7b1f3c7d0debd8c2b8ec85015b8d71d30cefdcd224b164b87a889

See more details on using hashes here.

Provenance

The following attestation bundles were made for esp_docs-2.4.0-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