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-1.9.1.tar.gz (16.0 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-1.9.1-py3-none-any.whl (16.1 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esp_docs-1.9.1.tar.gz
Algorithm Hash digest
SHA256 0948903eced627112e7e2c1d9877be29848540a915e94d96e2aeca1f97b8c7d8
MD5 57e6a9df8584d6976f270be2d18d8b17
BLAKE2b-256 3cfbcb6e69947f57318a2e1ab55aae6553ea8418fbc37deffb9cece92a73a9aa

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for esp_docs-1.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ec383ff427990ceb7089229655deeb793f4bf05061004311aa37d04a9cc19697
MD5 d882475e3a01af796793ef7ba34ac6fe
BLAKE2b-256 509ab835b7463c6ee34a6465910055ca3dd9e940716230c7f96cdc412f26d338

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