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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp_docs-1.10.1.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.1.tar.gz
Algorithm Hash digest
SHA256 b06e2a5ef6f6bf910f713731e6a5778b64e908b7883500ab921a62983b478e7f
MD5 385784d0363b19bfb7246ac246ec9a71
BLAKE2b-256 a6d1e99c5a67bfa1b4648611505d1e14ade111233c9623a97133680b57d898f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.10.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 da57cabb865a65993c5c3f48e8dffbd30bb1b08afc7bb38c2af77f34777c6ac9
MD5 5bab4b9011a5f88f9539fecb76be8f10
BLAKE2b-256 62615b002c09b903af092b24900ebb152e895660f9007a2d4190902f1bf4bfd9

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