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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esp-docs-1.3.0.tar.gz
Algorithm Hash digest
SHA256 7eae9ce5c9ca7b0d6eec9cadc0ceee927f7533e2d42ae897a5f207d916eb64fe
MD5 6711c8494ce8d624432c07d2d39f8e71
BLAKE2b-256 49598cb5935630a1073bfdd47f9f747dac592f0a045925dd891eec5ff32b838b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for esp_docs-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 57d14d80c5b64f7f017fbb66f9720a134197f7f2223bb94e73eef6d024a6443f
MD5 6b312b06012c4240a5f3398a5d28a13e
BLAKE2b-256 d297dfad2e2745f2bd3498a31020d29d47acb510b4e4baecf82736d80b5e874f

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