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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp_docs-2.3.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.3.0.tar.gz
Algorithm Hash digest
SHA256 265739d3409914205920d2d7b098f567ee0a99e70fd6bc5341e1cbfec370fbde
MD5 daf0f2bd26bfd87e577f136e50f1d064
BLAKE2b-256 de5f069df82052821d2d03770392ac4761e1517d2e919ad462686fe1aeea6439

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: esp_docs-2.3.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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79bb28707350510bb6aa49a50e06f5375b8b420c5e0cfe9decd36552968ab846
MD5 ed8811a3d60341f8f588e52f1a8ae141
BLAKE2b-256 2a79ce24dac7e3b94ccbd91a5bd5a47b72193d77d7ce693f190b389a9c1af7a1

See more details on using hashes here.

Provenance

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