https://github.com/espressif/esp-docs

Python based wrapper for Sphinx, intended to simplify and extend Sphinx's functionality to better suit the documentation needs for Espressif's development frameworks
https://github.com/espressif/esp-docs

Last synced: 2 days ago
JSON representation

Python based wrapper for Sphinx, intended to simplify and extend Sphinx's functionality to better suit the documentation needs for Espressif's development frameworks

• Host: GitHub
• URL: https://github.com/espressif/esp-docs
• Owner: espressif
• Created: 2021-08-05T09:32:28.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-05T09:20:09.000Z (22 days ago)
• Last Synced: 2024-09-18T15:59:05.851Z (8 days ago)
• Language: Python
• Size: 11.8 MB
• Stars: 22
• Watchers: 6
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# 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](https://docs.espressif.com/projects/esp-docs/en/latest/index.html).