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

Uploaded Python 3

File details

Details for the file esp-docs-1.5.0.tar.gz.

File metadata

  • Download URL: esp-docs-1.5.0.tar.gz
  • Upload date:
  • Size: 16.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.7.10

File hashes

Hashes for esp-docs-1.5.0.tar.gz
Algorithm Hash digest
SHA256 9f031946ca2c688e55e2fa9ab6bad17224551a81bbfb9b25ba81ae1858d2ef1d
MD5 df6ead08ff8c2f9f8449a4a41d91d7f5
BLAKE2b-256 7810f878dea250a799e05ad883e01f8e2f5cdd7846c91e8293f17b3bbb458595

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for esp_docs-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9eab070ca3aaf981066e9858a15ec51e5d189e8abfbc693edb48a1abf6574c5a
MD5 87bb3aeb911350f6c4669a5af3a2fc4f
BLAKE2b-256 9b0db6fac19f88108139217c8417b06db772572c303ae4fcd3812c46d5beda91

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