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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.2.4.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-0.2.4.tar.gz
Algorithm Hash digest
SHA256 c8049319c681c0af66846b4c91bacf8eaf7cb8feb21152448c99784afb31f30e
MD5 ebb1e4a9a68016126cd08608ce70a401
BLAKE2b-256 36e89ebd0f73cd159729b57dda32a038a0a4647057956f36829c5abfac5b21b2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.2.4-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-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ad331b65c9754822d967b664284123059322f992ba6d12545b60f7f9d4eafcce
MD5 15be83ebca7c256729554f73408739db
BLAKE2b-256 c9adc2a7f3c9ad28c39fa9c28315a1a08d2c61885da2c6374080b19f384884e6

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