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 in-depth guide on how to install, write, and compile documentation please see ESP-Docs User Guide.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.8.0.tar.gz
  • Upload date:
  • Size: 16.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for esp-docs-1.8.0.tar.gz
Algorithm Hash digest
SHA256 4c2e6fd093a22c1f118c3951af14562ea0c3ca6e7e80b73da583c2ae122174f7
MD5 2957d06578615f01a88cd6bb73743dff
BLAKE2b-256 dd43823b13b892bd5fcff943131dcb58ddfc4b2ee0382d136fbcdcab6f962aa5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for esp_docs-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3232092fa4449e7738bcb1d8a96f0e55c02f42b968b1d875958fc3978b596534
MD5 80d008748c8283780bb0331d03ce5882
BLAKE2b-256 2048ce47b49fe6955c6eb16ff159295fe9c5c3f69c959f6c4b680be51d22b134

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