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

Uploaded Python 3

File details

Details for the file esp_docs-1.10.3.tar.gz.

File metadata

  • Download URL: esp_docs-1.10.3.tar.gz
  • Upload date:
  • Size: 16.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for esp_docs-1.10.3.tar.gz
Algorithm Hash digest
SHA256 00cb25e47ed7e02ec19e3a67670ce8aa04377a727e3873effe5052dfa0fb766c
MD5 d4758a7ceb1372103f9244e9c5484608
BLAKE2b-256 7911e688b05f1c29d8bc6ef2d20578654d905a83537caf366fff0ecbd06d94a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.10.3-py3-none-any.whl
  • Upload date:
  • Size: 16.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for esp_docs-1.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a00e6439e2e3b8a63c77abceedaa3b333d9575f8608f0484779bb0aaa4de81ee
MD5 ef8fccfeb6c0a3d60030fb14afd75510
BLAKE2b-256 f555287fea2c92a73af2747af528fddff1c6750599b106fab2c762c037362b9d

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