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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.2.2.tar.gz
  • Upload date:
  • Size: 16.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.10

File hashes

Hashes for esp-docs-0.2.2.tar.gz
Algorithm Hash digest
SHA256 02ebf764316d4b706bfe955f17ef94373ced577e288ffb9483fccc376916644c
MD5 032ddccc4eda4b683154e224c8f0cb32
BLAKE2b-256 0070dd03948ff8abfe7c69c304aada5f3df0bc80a913f8e13127ea44cfed8d66

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 16.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.10

File hashes

Hashes for esp_docs-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f4a161fcc007d04ed782d4cd6a9067d14ef31e65f1ef39167682c66fe9c092aa
MD5 bfe8a2589d66089a2ce09975cf08ae7a
BLAKE2b-256 b7d24249260c39f4479982532f92ca113f876c85f53529eb7a00a455467afe94

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