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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.4.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.4.0.tar.gz
Algorithm Hash digest
SHA256 3ba41a249f25801908909eb0c2424b40c51db1062995abe413fe561e3dca0f34
MD5 9816c41f2dbd403e851a58b64b5d8c04
BLAKE2b-256 79fa58610378c915f058c6812f05686be7c5a6ebe8995a549703a78b03658aa6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.4.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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dfb0c1baf62dee189e61c0a895bf02df43d0a5bf4fe7c2eda6935c0f88e10f41
MD5 a6584800bbcf3d100b5e069a70f3826d
BLAKE2b-256 6b69ea999457564756ae1a15163bcfca7b3b0dd0285749d469865c4578a08ae8

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