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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esp_docs-1.11.0.tar.gz
Algorithm Hash digest
SHA256 1899bd0d8b45cd9905cda2bf8988ed80287d3d3cef51b2626b1a8a06129f1278
MD5 35b4e077ca88a25241e6d0ec9dd6ecbb
BLAKE2b-256 75ed0b4dfa781bcd86bb9fcbd6b1e76497679775ea7b0e25bbee553a98435774

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for esp_docs-1.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e60d736a1ea44bdfbe0caab232bb468306e3d611910de0063e11d5eda851807
MD5 a8abefe73c48d67080b67abb93e312be
BLAKE2b-256 0f9c655cec5796f1f9eede88a0af74e28ea73af36b429af9daebb543eee304c1

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