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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.4.2.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.4.2.tar.gz
Algorithm Hash digest
SHA256 ead78122861d65c7770a2ba0d82e21141721126d034e7a1685e3a0592cd41dec
MD5 4d883c786ed799b18f727acb6b1935ec
BLAKE2b-256 ebb10312cc57f55d3327ea8f7f2ba64785b40b4956c921e243d8a4fae476d7a1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.4.2-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.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 483431ac79ad2417da838a52356df306b2c11f76a02b032a8cb2bc035fe0dc14
MD5 06cdabe76cf538d0a257e476fc80b8ca
BLAKE2b-256 4f22e9f50d5f944fecb34a32cd7ce58d71c03805c0a0f8f08845b62e350fd519

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