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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.6.1.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.6.1.tar.gz
Algorithm Hash digest
SHA256 79a4d34c9645b41e54e496b3fabdc81abcf4727d1df030eeddba20d8ceacb7d3
MD5 7714dcb89d8d9d9caf8a5813652446d9
BLAKE2b-256 7a4f9ca1d789000315e1f7b0b1dc18bd70c8778ea38fffc705a5cc9122f594e7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.6.1-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.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 de17d6cb082e5f9042106b14942c0d0a0254e6f011673a25a9fe4f9c12326aaf
MD5 72f757ca2beb33f5ce95575f749ad3f1
BLAKE2b-256 ea473cc4132c38fc3ba63f32f304bfd512745c3cc13cc3a25851661a9e5733b2

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