Solaar/docs
MattHag 59b30706b8
docs: Use mkdocs for public documentation (#2527)
* Add mkdocs config

Build and debug docs locally:
mkdocs serve

* Add mkdocs config

* Introduce GitHub action for mkdocs

* Delete outdated doc files

* Generate Python documentation

* Clean up docs

- Remove ToDos from public docs
2024-07-01 08:03:50 -04:00
..
devices settings: improve label and description for LED zone settings 2024-04-19 16:05:29 -04:00
img docs: Use mkdocs for public documentation (#2527) 2024-07-01 08:03:50 -04:00
reference docs: Use mkdocs for public documentation (#2527) 2024-07-01 08:03:50 -04:00
screenshots docs: Move screenshots into dedicated folder 2024-05-16 15:55:44 -04:00
.gitignore pre-commit: initial fix 2020-07-07 15:11:15 +01:00
20121210110342697.pdf new UI mock-up from Julien Gascard 2012-12-12 21:45:37 +02:00
README.md cleanup and lint the docs 2020-08-02 11:25:00 -04:00
capabilities.md docs: Use mkdocs for public documentation (#2527) 2024-07-01 08:03:50 -04:00
debian.md cleanup and lint the docs 2020-08-02 11:25:00 -04:00
devices.md hid: copy newer version of hid_parser into Solaar codebase 2024-02-26 14:19:16 -05:00
features.md Fix sentences and punctuation in features.md (#2029) 2023-04-02 19:43:32 -04:00
hidpp-documentation.txt docs: remove logitech files and outdated information; update supported features 2020-07-11 15:36:49 -04:00
i18n.md release 1.1.12rc1 2024-04-19 03:54:54 -04:00
implementation.md docs: Use mkdocs for public documentation (#2527) 2024-07-01 08:03:50 -04:00
index.md release 1.1.13rc1 2024-05-08 14:37:55 -04:00
installation.md docs: add requirement for CONFIG_HIDRAW 2024-03-07 16:32:41 -05:00
rules.md docs: update built-in rules 2024-06-01 11:59:57 -04:00
usage.md docs: Move screenshots into dedicated folder 2024-05-16 15:55:44 -04:00
usb.ids.txt docs: update the USB IDs list 2019-12-29 14:46:59 +00:00

README.md

Documentation Readme

This project's documentation is hosted using GitHub pages, which serves static pages using Jekyll. Please refer to the official documentation for instructions for how to build the site locally.