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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.7.1.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.7.1.tar.gz
Algorithm Hash digest
SHA256 0111ec980ce004b29a7e8a9ac4d2f86ed8750e984647b75f1c9fe09e9623c731
MD5 667047de273d355f66c4c8de87763942
BLAKE2b-256 b8d8a56553eb8f81bfaecc977519c4ae87af9ec7c1ec2989d46f5ed10b9c9aeb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.7.1-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.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 be081e60732e37c6570fa9da0ebd8886879ae540d9cd89572ff3c3a1385fb53f
MD5 7eda6b66fbd38c3237e42e0b28d14404
BLAKE2b-256 e76e0229bde8cdfe3a1585c3d4c3bfc88f737a8a0c70f6fbd8cc5235afea5ff6

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