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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp_docs-2.0.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-2.0.0.tar.gz
Algorithm Hash digest
SHA256 12deaadfcd3d1b5d4222ea91d375d11474f02a7597a846e9c6f55639067c21de
MD5 d97c877b4104bb099396275232c32f92
BLAKE2b-256 dbdbb86c9f608ba93dac834401c21507bd3d3caf70f52d441a4d554e631c463e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-2.0.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-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff343409436f5a6fa81109b5839572e83c755f56da1256ae958714450d8ee39e
MD5 6bd491fef0436c653d7c05cf0570b037
BLAKE2b-256 ebee4a9b1bb5b6b5ef00864932eadd3adea4faa876ce5746cec241dc52728d87

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