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 indepth guide on how to install, write and compile documentation please see writing-documention and building-documention.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.2.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.2.0.tar.gz
Algorithm Hash digest
SHA256 1ec26993391d239ee46a836d521d2e783a6033927e44b79860e32cde253b292a
MD5 ab53329c8e277cbe6db754c062e5bae1
BLAKE2b-256 b0c53e8a8c033b15dda51959a7ff4ce57dc9cf29ecc2a5af0b3174736ee046b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.2.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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16ad017b5e7850e025834c2c92eb65fbab8c2d9347630381f10b88088eb69ce5
MD5 569176ebe8802a571db17d4c47c767ec
BLAKE2b-256 95e5ac192e795606f954e39d661dbd618b063e339f356c05dbce6ab0e19dff2c

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