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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp_docs-2.0.1.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.0.1.tar.gz
Algorithm Hash digest
SHA256 028b1eae9e917734f82b9fd04e41e767b4b15929c00a62c03b22d6452ae5f27a
MD5 55fef1b4b33019687f495be2493b50c7
BLAKE2b-256 769ae91d9dd95c4dcb402739d8f1843e7a7b4759e7873dd8784fed9f8598b143

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-2.0.1-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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc87112cd396160b8773cce2552c21922511e1307e1f9dfb09d7add60a3f5bd0
MD5 532a5db594b9ddc422333cd4f4158c17
BLAKE2b-256 433d434073758bb295e820738a7b77f10c410c821633870bdd6db83b30b933db

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