https://github.com/shadowblip/opengamepadui-docs

OpenGamepadUI official documentation
https://github.com/shadowblip/opengamepadui-docs

Last synced: 3 months ago
JSON representation

OpenGamepadUI official documentation

• Host: GitHub
• URL: https://github.com/shadowblip/opengamepadui-docs
• Owner: ShadowBlip
• License: other
• Created: 2023-08-14T16:36:08.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-07T06:46:27.000Z (4 months ago)
• Last Synced: 2025-02-07T07:28:55.290Z (4 months ago)
• Language: CSS
• Size: 4.77 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing/development/adding_a_new_platform.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# OpenGamepadUI Documentation

[![Documentation Status](https://readthedocs.org/projects/opengamepadui/badge/?version=latest)](https://opengamepadui.readthedocs.io/en/latest/?badge=latest)

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](https://github.com/godotengine/godot-docs).

## Usage

You can build and preview the documentation using the included [Dockerfile](Dockerfile)

and Makefile.

To build the documentation HTML, run:

```bash

make build

```

To open the documentation in your brower locally, run:

```bash

make preview

```