Metadata-Version: 2.1
Name: esp-docs
Version: 0.0.3
Summary: Documentation building package used at Espressif
Home-page: https://github.com/espressif/esp-docs
Author: Espressif
Author-email: marius.vikhammer@espressif.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/espressif/esp-docs/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: cairosvg (==2.5.1)
Requires-Dist: sphinx (==2.3.1)
Requires-Dist: breathe (==4.14.1)
Requires-Dist: sphinx-copybutton (==0.3.0)
Requires-Dist: sphinx-notfound-page
Requires-Dist: sphinxcontrib-blockdiag (==2.0.0)
Requires-Dist: sphinxcontrib-seqdiag (==2.0.0)
Requires-Dist: sphinxcontrib-actdiag (==2.0.0)
Requires-Dist: sphinxcontrib-nwdiag (==2.0.0)
Requires-Dist: sphinxcontrib-wavedrom (==2.0.0)
Requires-Dist: sphinxcontrib-svg2pdfconverter[cairosvg] (==1.1.0)
Requires-Dist: nwdiag (==2.0.0)
Requires-Dist: recommonmark
Requires-Dist: future (>=0.16.0)
Requires-Dist: sphinx-selective-exclude (==1.0.3)
Requires-Dist: sphinx-idf-theme (==0.3.0)


# 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](docs/writing-documention.md) and [building-documention](docs/building-documention.md).


