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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.4.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.4.1.tar.gz
Algorithm Hash digest
SHA256 4dc6eb67b0aaa743822e22bd7bd6dafae2825e4e939f55e9cea15f4abc2c35eb
MD5 62cd8758f833306d694ba56582078942
BLAKE2b-256 32eb30fe0fdb556a4610b916f2f25cd591387a96a203d86bc99c3712c7e490a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.4.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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ba269b1f2fab275dd0b39fecb62a6603b4af0c782a0b0edf1b53ce8de1c1959b
MD5 2400dd7a3b982df76e5e2c72fe050a11
BLAKE2b-256 df5622d8fed6951b3618ee83c2efab63cd3e3306d6e01230d3ffae8c94b4bda5

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