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

Uploaded Python 3

File details

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

File metadata

  • Download URL: esp-docs-1.0.2.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.0.2.tar.gz
Algorithm Hash digest
SHA256 70c575b3e1737c6db870f15aa7e7270677ee50f003e9ba6c6f95b789b91db3c1
MD5 97db3fd9203d39ca8887b337212f64e9
BLAKE2b-256 49ad5aef3f9c138a88b752b11fb8d22498bf54a5305fb7216f83c8baf196d4d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: esp_docs-1.0.2-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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5c85de4e0ff8c9f7dfadb3c0b6c2b20c665696a4da93ea074f6b2fd2affc9486
MD5 31da8388070861a0f37177e54b2e4df5
BLAKE2b-256 39d58e8c899fb17e43461615cbbd35d7bf8df4641f0dd49bc2b8221de1fd7fbe

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