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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 40fe4c1ed4353fc373ae818ce54ce59c4b3d618ab9466ac4ec051556317b9a75
MD5 c0cec96187adb2ae13750612898fef8f
BLAKE2b-256 5a5432b6022a3173ca4fccacd16c465b15d5af361ff37fdeb312d242f0525b08

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc1ca3a0d4a58b1fc17afd76b516e5cc3d6394bea18507758f8449176a71c644
MD5 9775e37b200d7b39750ab6abdb51a4dd
BLAKE2b-256 671d04311e6973158456f554766439e4768ec40d6df8f758fa5a09cc00967c7d

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