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.10.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.10.0-py3-none-any.whl (16.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp_docs-1.10.0.tar.gz
  • Upload date:
  • Size: 16.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for esp_docs-1.10.0.tar.gz
Algorithm Hash digest
SHA256 aab0aafa177d3f4583f03b15381691b754aed720bece0f793bc5e118243dad3f
MD5 b0b66b31082faf14f245fb6fac89cb8e
BLAKE2b-256 6cb050c11b5b8c381aab0029ff626a6ba4ed057342261514ce705497322e95c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.10.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for esp_docs-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 25eb66aa7a6320e0d1d5ff0f63bed9b176cc685285a59e57d1dd856ae3a85c9a
MD5 94ab392e5f6797c3f2ce6854a7f849af
BLAKE2b-256 d8b6dd81480b703cefa2fcf7b12d24c04a28edbb1cd51b392ee500331b8b536d

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