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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esp_docs-2.1.4.tar.gz
Algorithm Hash digest
SHA256 435812150a516f044bd7e1ced5b0361a430ed2706fab54247f81ca0bc0830da3
MD5 e27845cb8dd0b0895b8f147e22a0f6a2
BLAKE2b-256 8b2b1a1360e0b181be94700702e4ddbe354098b2b8225f76fdc489ebadaa172b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for esp_docs-2.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 670676a6ede944a4fc43aaacd5b4a0e5a9ed431f0ef9a2fc5109e6be6129d923
MD5 7ee2b387d6470ca3aac795ef624e3638
BLAKE2b-256 70cae0147317b2b8c0b95e3614e4bf0c9986374e47452cc403e1d5b133e9afc5

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