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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.6.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.6.0.tar.gz
Algorithm Hash digest
SHA256 4da677d97ff44947240670509a8abdb4be5dde4c677c852875f2375ab3ab0f69
MD5 73c312bbed2546d1b413a24316ff910e
BLAKE2b-256 7438fea635fedbc771d90b16cb46ff590b9327a43a07831c4fb2efabf6c9560e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.6.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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08c21eda1845421b34e14823f2b150ba957e0741a24c823b57771560585d0a64
MD5 550423ae0d59079fb0b31aa05dfa29d5
BLAKE2b-256 aeea1c9e1984945b5ddb11ab3f0f3920d3fb9f40d8c42ca11b9375769b1e3a04

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