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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp_docs-1.9.2.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.2.tar.gz
Algorithm Hash digest
SHA256 d8af76943e5b275846255ce4322da8e8c38f9d0e6b8dd477c8b2954a648c39ac
MD5 b52d668266dca7e7e7361cdcab0a5c3e
BLAKE2b-256 102d4024af33badad1d97ab1b9c3cb1c44d6abc8ef30f95486e42e8348e95f8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.9.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5458b0a482d794bc36c20352645f482175008fd8c6d1174a93154ff37a3529be
MD5 99f6b7e70b6cd4aeb46460b7620f7f46
BLAKE2b-256 829962d8867742005181079b90c0f27c948807f3662b72216b39398537c89ad9

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