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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.7.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.7.0.tar.gz
Algorithm Hash digest
SHA256 247e060e8875ae32deee00d2cdb66bad6dc8d48c58f8fad84942e3547fc17aba
MD5 e45975f0ea0e9f53c6540794e635ae90
BLAKE2b-256 6c8675882b11bc3dfc229fefcaf8939b0c44c8a1a0b27fdd5d3af5316c77db8d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.7.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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c1fd50795d875147952029ff6ff4d3713e74017eb0ab883da29a31a2e9e9e0e
MD5 e04b9e3bc56733a79c19bb37acf0fb01
BLAKE2b-256 bf851d517f66fdf484300c438164273d9f670af6c72e6dfd15cbb4919bbd72c7

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