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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.1.1.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.1.1.tar.gz
Algorithm Hash digest
SHA256 dabbf53431e34cdbff5d252f48d3c7ddbb72fe3d2a10fa4ab299edf1c9691726
MD5 aa20e0051795c70a9763411677fdf1ea
BLAKE2b-256 b3baf8890fbf163f1b888af08319a00318144501dfbd5070b8458e4d6d222bd6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.1.1-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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c8f9f3e02a19c1257f390f1d7ef0b5fc783c0d9fe6df1e098e85488fc04aec56
MD5 1608bd4b3b26ccaa2df65db1ce50ea88
BLAKE2b-256 c5b67dd25a7dac6ff3bf8142281be17afe912750185fb0259c7387b9ef08cfd0

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