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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.0.3.tar.gz
  • Upload date:
  • Size: 16.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.6.10

File hashes

Hashes for esp-docs-0.0.3.tar.gz
Algorithm Hash digest
SHA256 b25627f21f3acb261ff3c7b398b367952092d6a950075a8aa83abd203418d403
MD5 30b9d7b4defbcf3a06db9a5cee880bd5
BLAKE2b-256 7f97753cf49f7088e14035f3df7cffc99f310afbce8b17f877ffad203080e8c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 16.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.6.10

File hashes

Hashes for esp_docs-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2dfdfd9dded7abe09cc0d84fff2171d924345edb3ca1571bd5747c6560869e4c
MD5 903d071b468e5ae7b7de10c151a043cf
BLAKE2b-256 8f6eaee25f9997c2cc674d16b8da53c05453d480785e1d7ce5ee8f0422e98242

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