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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.2.5.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-0.2.5.tar.gz
Algorithm Hash digest
SHA256 08d6859cc887aaa6b1a841f8ae7e077903f108e19b5d21fd16e64c1af8bd99d0
MD5 1f8ab3285a4cdc9fb22fdb665ad892db
BLAKE2b-256 6c3eaa164e404a98621cda6ff18cc049f048084b1dc5b0914ac598728910acf3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.2.5-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-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7d76095c8bb1e8163d52005f372b93831ad8769512dc6f09e5fd7de0b2b25e32
MD5 3cd202f96537ede0be7e1bc373a1c949
BLAKE2b-256 5a3b25ccd8786148ea10c42f995b84613bf141aa0eaba0139c1dd74dfc1079ac

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