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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp_docs-2.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 1e1714e49ebc34bc41458b73a5bec00af793137d01555114fc17e4fee6cb3897
MD5 872c5b11749ee459434b5b059a9efd6b
BLAKE2b-256 e5fa04faed099b9f84f149ed9486a7cd17963d4afafe9dbf91d4d5c4fe847b0a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-2.1.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5fdc7be040548dc1594ac5100c575dcb5f6f29a216ece81b76f0d843c422617f
MD5 0d9159cec67e8772e5cee13211043c72
BLAKE2b-256 5d6306b952d26f022fa6e142552f9f35aaf8997907ce11314e235788fa5aa4e5

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