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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-0.2.3.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.3.tar.gz
Algorithm Hash digest
SHA256 57d4ce50b1fff4e01defc01edefe81577975705b6fd35d732325ff710520a540
MD5 b198f4afeb1a60f6f066f53499e9419b
BLAKE2b-256 b531c9fda893f016317d8dd1233ff85b6dcd286573712f92a2bfdd47ba345527

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-0.2.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3eaabd1835c0e67aea6b5819e1e7ba8d23dca8b8bcca6b7e77446523d7df5ae4
MD5 b89b64ec5c35c2a814fc01f3db2c3d7c
BLAKE2b-256 e96de0649b2bb2251f9a582abe46b0e1c05473a3c4b5eff1706e91c9eaff4222

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