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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.2.0.tar.gz
  • Upload date:
  • Size: 16.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.2.0 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.13

File hashes

Hashes for esp-docs-0.2.0.tar.gz
Algorithm Hash digest
SHA256 50d18099d9493eda85a5326ee20bcb3473768c15f514bb1e1d1d1a207f782ae4
MD5 768d187854f84b4ff4ab80c29ddded00
BLAKE2b-256 e5c52b3c12ebc5d27c5eb2ae635e3d3a27cb2665b59688276beda88c09868db2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.2.0 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.13

File hashes

Hashes for esp_docs-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f25ce641cdee1869af99c24919da9df06d74253afd608d990d8b32978c6d07d
MD5 28d4c6d239580b4a9f041482ab40a937
BLAKE2b-256 61367fa9eabc3bdccaa877e6d683a494bfb08d1e19ee82e554aacc5106e796c1

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