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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esp_docs-1.12.0.tar.gz
Algorithm Hash digest
SHA256 6909dac879fa42db1b968c6d16a63ea4bf3e7fadc9eb9c3f7cd2fac70af1f2fc
MD5 78d55f150f04527ffce9ff343052def6
BLAKE2b-256 51b4c24f876086a7d24ebe49e5b1b3db68c8fd6dc39d1286a01ce5f052233316

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for esp_docs-1.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a991a9c3a7a28e2e19d8c0e5d6e46a2e8a02024f39e05e6b1b02868331c27109
MD5 4f996a0b6d26692adb59bef218420b3f
BLAKE2b-256 add591aede5c48b706d373c6d141aa7e7349d0c41b62f47688ed106c9feb406b

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