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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp_docs-2.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 6a8370069cd60f3b6c4739c0076df7d7d443c84e91fe2d99ef61ebdfd298e376
MD5 f6140360ab5432da4190a39f9ca77d2e
BLAKE2b-256 2b242d8404530acff1b1bf623b0c5db4110237e0787794686feaad2230e01d5a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-2.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4288069b9d6ec2f1476af0937da8ce7ccf48614385649301aee3b75a712a1a32
MD5 44b6c71568ac0a1a9fd3ec04b26fea0b
BLAKE2b-256 10eaee851ea93260409eb85d68dcf2b0644110d296abfed0b14c8299c13917f8

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