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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.2.1.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.1.tar.gz
Algorithm Hash digest
SHA256 0ef269e92d951f0ea89cfe1956235759481f013368dc7ba65a748b2b39f1967b
MD5 83ec0d108eec2e99292c857d2f39bca1
BLAKE2b-256 4a6d9a746b89308577069388e58c425748e74bd662413cc669630de3c9049537

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.2.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6489691b8295e8477ff6a83064f5576fdd619ccfc50cc20dae5fd606ca8eed5d
MD5 7e7b834ecda49ef69b94ffd64737f535
BLAKE2b-256 fb41e317e9cc4101f3f8d3b8c4f75e2454abcec50e5173fe6738049f8c1b2c15

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