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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.5.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.5.1.tar.gz
Algorithm Hash digest
SHA256 de5541b5f996da75ad4307c5ecac2abc5109cecd81180511f7538f7573ceb403
MD5 6f7dfee624d368006e556c941ee3aecd
BLAKE2b-256 2cc4b0b4faff2e8209a50a3e6106c569ead8fa2d4159ab259ecb94ca28c4de3b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.5.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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 769adbf472f60df5c6d8445637e0989d4a607b8d63368095b7bb3598ccd5cdbc
MD5 613cadd475515e447589fec589d207fa
BLAKE2b-256 f9626ec8d40a9dbc43dcbe7104fb772691917a6e6e647ee6ab4d644aea81d33c

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