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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.0.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.0.0.tar.gz
Algorithm Hash digest
SHA256 67572ca7cc12668c2b52e4625d58dd5d9959e10fffba620d502a445be6cb60a7
MD5 5d00053f2421b9f13fd10a7037bb5e54
BLAKE2b-256 451c2386fb7ee9e0106aff04b4efacb253b161257ff54aff17dfd6a72a1bf779

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.0.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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d06be8c7b77a47f3334cf823559a8841c400d355d5aec3a2db01b4a63796f87
MD5 e711a467c4ca39b65307bf4aa0b2231b
BLAKE2b-256 a556098a6f02d480bea32984aed2505fb6d398289a5e655b478247d15743efe6

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