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 indepth guide on how to install, write and compile documentation please see writing-documention and building-documention.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.1.0.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.1.0.tar.gz
Algorithm Hash digest
SHA256 10f63815b433afae6a7f952848dffec1a81f1fd7f355dccffccd392e98a67d3b
MD5 0bdcb81dba0e7920c987a46f961dc7d4
BLAKE2b-256 eee13c0a1bea77d1399c68c76894e0292d24452f982776c20b7e58d72b2f8b90

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.1.0-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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6131d639cc5667b839e6b4d6093b2a52a9b178ef1c4e1c838308353d120ef989
MD5 377f7e6f8b2c1825d69fd842d093f77c
BLAKE2b-256 df78c685051e42f56b78300f71829b86c2d896f0f0eefc1548ca16a9f4c445c5

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