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.1.3.tar.gz (15.9 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.1.3-py3-none-any.whl (16.0 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esp_docs-2.1.3.tar.gz
Algorithm Hash digest
SHA256 35644b38d69b1f0f7d9e6d39a7c14326208012fa7aff8f7956e37b7c9f45448a
MD5 1871d2f381cc5b9ad9bd6d68a33ec1e9
BLAKE2b-256 7b72f52ff27ceb093515ed53f5d9126de61afafc6fd9d26741948b23b251f64d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for esp_docs-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7a2a5d5a8ef50b71eed60367cd683035759312008aa31664adeddfa2d11a021c
MD5 80b22196b50e4559e1eb3ad08b95b85f
BLAKE2b-256 08ca00d8a63ff6ca3c43ed9f7ba744e044862df8f00ed2c66defca5ffd519d08

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