README.md

OpenGamepadUI Documentation

Warning

This repository has been deprecated. Documentation is now stored in the main OpenGamepadUI repository.

This repository contains contains the source files of OpenGamepadUI's documentation in reStructuredText markup.

These are meant to be parsed with the Sphinx documentation builder to build HTML documentation. The theme and structure of the documentation has been largely derived from Godot Engine's documentation.

Usage

You can build and preview the documentation using the included Dockerfile and Makefile.

To build the documentation HTML, run:

make build

To open the documentation in your brower locally, run:

make preview