Skip to content

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

Notifications You must be signed in to change notification settings

espressif/esp-docs

Folders and files

NameName
Last commit message
Last commit date
Sep 7, 2022
Mar 2, 2022
Sep 7, 2022
Sep 6, 2022
Aug 10, 2022
Jun 18, 2021
May 17, 2021
Sep 7, 2022
Jun 18, 2021
May 17, 2021
Sep 6, 2022
May 17, 2021

Repository files navigation

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.

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published