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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.0.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.0.1.tar.gz
Algorithm Hash digest
SHA256 7a8517a2194d6422ad8a66bf25ecdd232f03468a57735d59f53ee70d6ddb90c9
MD5 489d637fbefbf6788358878d98c5d99e
BLAKE2b-256 f5a27e23f79a1aef4d79090d74ef5adb25695bdb61a2942f98023c24edb161f3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.0.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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 616418cdeb1a0378aaf61998391b7db7c61094a4fc99b09305e02247fa0d318d
MD5 f5d436c8c5325d8fb1346838b2851d10
BLAKE2b-256 5184ac81feb14f948723c7e66251550d9ce1f40a774ea75e1ad8aa60fbf33986

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