diff --git a/.gitignore b/.gitignore index 0dfa6dda..1e42461d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,4 @@ .#* /output/ /examples/*/output/ -docs/_build -docs/doxyoutput -docs/api - +/out/ diff --git a/docs/Makefile b/docs/Makefile index bef71981..333950eb 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -3,10 +3,10 @@ # You can set these variables from the command line, and also # from the environment for the first two. -SPHINXOPTS ?= +SPHINXOPTS ?= -c ../etc/docs SPHINXBUILD ?= sphinx-build SOURCEDIR = . -BUILDDIR = _build +BUILDDIR = ../out/docs # Put it first so that "make" without argument is like "make help". help: diff --git a/UPGRADING.md b/docs/UPGRADING.md similarity index 100% rename from UPGRADING.md rename to docs/UPGRADING.md diff --git a/doc/device-apis.md b/docs/api-reference/device-apis.md similarity index 100% rename from doc/device-apis.md rename to docs/api-reference/device-apis.md diff --git a/doc/plugin-api-internals.md b/docs/api-reference/plugin-api-internals.md similarity index 100% rename from doc/plugin-api-internals.md rename to docs/api-reference/plugin-api-internals.md diff --git a/doc/CODING_STYLE.md b/docs/codebase/code-style.md similarity index 100% rename from doc/CODING_STYLE.md rename to docs/codebase/code-style.md diff --git a/doc/glossary.md b/docs/codebase/glossary.md similarity index 100% rename from doc/glossary.md rename to docs/codebase/glossary.md diff --git a/doc/driver/Bootloader.md b/docs/drivers/Bootloader.md similarity index 100% rename from doc/driver/Bootloader.md rename to docs/drivers/Bootloader.md diff --git a/doc/driver/led/WS2812.md b/docs/drivers/led/WS2812.md similarity index 100% rename from doc/driver/led/WS2812.md rename to docs/drivers/led/WS2812.md diff --git a/doc/plugin/Hardware-EZ-ErgoDox.md b/docs/hardware-devices/Hardware-EZ-ErgoDox.md similarity index 100% rename from doc/plugin/Hardware-EZ-ErgoDox.md rename to docs/hardware-devices/Hardware-EZ-ErgoDox.md diff --git a/doc/plugin/Hardware-Model01.md b/docs/hardware-devices/Hardware-Model01.md similarity index 100% rename from doc/plugin/Hardware-Model01.md rename to docs/hardware-devices/Hardware-Model01.md diff --git a/doc/plugin/Hardware-OLKB-Planck.md b/docs/hardware-devices/Hardware-OLKB-Planck.md similarity index 100% rename from doc/plugin/Hardware-OLKB-Planck.md rename to docs/hardware-devices/Hardware-OLKB-Planck.md diff --git a/doc/plugin/Hardware-SOFTHRUF-Splitography.md b/docs/hardware-devices/Hardware-SOFTHRUF-Splitography.md similarity index 100% rename from doc/plugin/Hardware-SOFTHRUF-Splitography.md rename to docs/hardware-devices/Hardware-SOFTHRUF-Splitography.md diff --git a/doc/plugin/Hardware-Technomancy-Atreus.md b/docs/hardware-devices/Hardware-Technomancy-Atreus.md similarity index 100% rename from doc/plugin/Hardware-Technomancy-Atreus.md rename to docs/hardware-devices/Hardware-Technomancy-Atreus.md diff --git a/doc/model01_coordinates.png b/docs/hardware-devices/keyboardio/model01/model01_coordinates.png similarity index 100% rename from doc/model01_coordinates.png rename to docs/hardware-devices/keyboardio/model01/model01_coordinates.png diff --git a/docs/index.rst b/docs/index.rst index 6f98fb7e..6e96bf58 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,61 @@ Welcome to Kaleidoscope's documentation! :caption: Contents: +Supported input devices +======================= +.. toctree:: + :maxdepth: 2 + :glob: + + hardware-devices/* + +Plugins +======= + +.. toctree:: + :maxdepth: 1 + :glob: + + plugins/* + + +For developers +============== + +.. toctree:: + :maxdepth: 1 + + codebase/glossary.md + codebase/code-style.md + +API Design docs +=============== + +.. toctree:: + maxdepth: 1 + :glob: + + api-reference/* + + +Device drivers +============== +.. toctree:: + :maxdepth: 2 + :glob: + + drivers/** + + + +Upgrading from old versions +=========================== + +.. toctree:: + :maxdepth: 2 + + UPGRADING.md + Indices and tables ================== diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..2119f510 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/doc/plugin/Colormap.md b/docs/plugins/Colormap.md similarity index 100% rename from doc/plugin/Colormap.md rename to docs/plugins/Colormap.md diff --git a/doc/plugin/Cycle.md b/docs/plugins/Cycle.md similarity index 100% rename from doc/plugin/Cycle.md rename to docs/plugins/Cycle.md diff --git a/doc/plugin/CycleTimeReport.md b/docs/plugins/CycleTimeReport.md similarity index 100% rename from doc/plugin/CycleTimeReport.md rename to docs/plugins/CycleTimeReport.md diff --git a/doc/plugin/DynamicMacros.md b/docs/plugins/DynamicMacros.md similarity index 100% rename from doc/plugin/DynamicMacros.md rename to docs/plugins/DynamicMacros.md diff --git a/doc/plugin/DynamicTapDance.md b/docs/plugins/DynamicTapDance.md similarity index 100% rename from doc/plugin/DynamicTapDance.md rename to docs/plugins/DynamicTapDance.md diff --git a/doc/plugin/EEPROM-Keymap-Programmer.md b/docs/plugins/EEPROM-Keymap-Programmer.md similarity index 100% rename from doc/plugin/EEPROM-Keymap-Programmer.md rename to docs/plugins/EEPROM-Keymap-Programmer.md diff --git a/doc/plugin/EEPROM-Keymap.md b/docs/plugins/EEPROM-Keymap.md similarity index 100% rename from doc/plugin/EEPROM-Keymap.md rename to docs/plugins/EEPROM-Keymap.md diff --git a/doc/plugin/EEPROM-Settings.md b/docs/plugins/EEPROM-Settings.md similarity index 100% rename from doc/plugin/EEPROM-Settings.md rename to docs/plugins/EEPROM-Settings.md diff --git a/doc/plugin/Escape-OneShot.md b/docs/plugins/Escape-OneShot.md similarity index 100% rename from doc/plugin/Escape-OneShot.md rename to docs/plugins/Escape-OneShot.md diff --git a/doc/plugin/FingerPainter.md b/docs/plugins/FingerPainter.md similarity index 100% rename from doc/plugin/FingerPainter.md rename to docs/plugins/FingerPainter.md diff --git a/doc/plugin/FirmwareDump.md b/docs/plugins/FirmwareDump.md similarity index 100% rename from doc/plugin/FirmwareDump.md rename to docs/plugins/FirmwareDump.md diff --git a/doc/plugin/FocusSerial.md b/docs/plugins/FocusSerial.md similarity index 100% rename from doc/plugin/FocusSerial.md rename to docs/plugins/FocusSerial.md diff --git a/doc/plugin/GhostInTheFirmware.md b/docs/plugins/GhostInTheFirmware.md similarity index 100% rename from doc/plugin/GhostInTheFirmware.md rename to docs/plugins/GhostInTheFirmware.md diff --git a/doc/plugin/Heatmap.md b/docs/plugins/Heatmap.md similarity index 100% rename from doc/plugin/Heatmap.md rename to docs/plugins/Heatmap.md diff --git a/doc/plugin/HostOS.md b/docs/plugins/HostOS.md similarity index 100% rename from doc/plugin/HostOS.md rename to docs/plugins/HostOS.md diff --git a/doc/plugin/HostPowerManagement.md b/docs/plugins/HostPowerManagement.md similarity index 100% rename from doc/plugin/HostPowerManagement.md rename to docs/plugins/HostPowerManagement.md diff --git a/doc/plugin/IdleLEDs.md b/docs/plugins/IdleLEDs.md similarity index 100% rename from doc/plugin/IdleLEDs.md rename to docs/plugins/IdleLEDs.md diff --git a/doc/plugin/LED-ActiveLayerColor.md b/docs/plugins/LED-ActiveLayerColor.md similarity index 100% rename from doc/plugin/LED-ActiveLayerColor.md rename to docs/plugins/LED-ActiveLayerColor.md diff --git a/doc/plugin/LED-ActiveModColor.md b/docs/plugins/LED-ActiveModColor.md similarity index 100% rename from doc/plugin/LED-ActiveModColor.md rename to docs/plugins/LED-ActiveModColor.md diff --git a/doc/plugin/LED-AlphaSquare.md b/docs/plugins/LED-AlphaSquare.md similarity index 100% rename from doc/plugin/LED-AlphaSquare.md rename to docs/plugins/LED-AlphaSquare.md diff --git a/doc/plugin/LED-Palette-Theme.md b/docs/plugins/LED-Palette-Theme.md similarity index 100% rename from doc/plugin/LED-Palette-Theme.md rename to docs/plugins/LED-Palette-Theme.md diff --git a/doc/plugin/LED-Stalker.md b/docs/plugins/LED-Stalker.md similarity index 100% rename from doc/plugin/LED-Stalker.md rename to docs/plugins/LED-Stalker.md diff --git a/doc/plugin/LED-Wavepool.md b/docs/plugins/LED-Wavepool.md similarity index 100% rename from doc/plugin/LED-Wavepool.md rename to docs/plugins/LED-Wavepool.md diff --git a/doc/plugin/LEDControl.md b/docs/plugins/LEDControl.md similarity index 100% rename from doc/plugin/LEDControl.md rename to docs/plugins/LEDControl.md diff --git a/doc/plugin/LEDEffect-BootAnimation.md b/docs/plugins/LEDEffect-BootAnimation.md similarity index 100% rename from doc/plugin/LEDEffect-BootAnimation.md rename to docs/plugins/LEDEffect-BootAnimation.md diff --git a/doc/plugin/LEDEffect-BootGreeting.md b/docs/plugins/LEDEffect-BootGreeting.md similarity index 100% rename from doc/plugin/LEDEffect-BootGreeting.md rename to docs/plugins/LEDEffect-BootGreeting.md diff --git a/doc/plugin/LEDEffect-Breathe.md b/docs/plugins/LEDEffect-Breathe.md similarity index 100% rename from doc/plugin/LEDEffect-Breathe.md rename to docs/plugins/LEDEffect-Breathe.md diff --git a/doc/plugin/LEDEffect-Chase.md b/docs/plugins/LEDEffect-Chase.md similarity index 100% rename from doc/plugin/LEDEffect-Chase.md rename to docs/plugins/LEDEffect-Chase.md diff --git a/doc/plugin/LEDEffect-Rainbow.md b/docs/plugins/LEDEffect-Rainbow.md similarity index 100% rename from doc/plugin/LEDEffect-Rainbow.md rename to docs/plugins/LEDEffect-Rainbow.md diff --git a/doc/plugin/LEDEffect-SolidColor.md b/docs/plugins/LEDEffect-SolidColor.md similarity index 100% rename from doc/plugin/LEDEffect-SolidColor.md rename to docs/plugins/LEDEffect-SolidColor.md diff --git a/doc/plugin/LEDEffects.md b/docs/plugins/LEDEffects.md similarity index 100% rename from doc/plugin/LEDEffects.md rename to docs/plugins/LEDEffects.md diff --git a/doc/plugin/Leader.md b/docs/plugins/Leader.md similarity index 100% rename from doc/plugin/Leader.md rename to docs/plugins/Leader.md diff --git a/doc/plugin/Macros.md b/docs/plugins/Macros.md similarity index 100% rename from doc/plugin/Macros.md rename to docs/plugins/Macros.md diff --git a/doc/plugin/MagicCombo.md b/docs/plugins/MagicCombo.md similarity index 100% rename from doc/plugin/MagicCombo.md rename to docs/plugins/MagicCombo.md diff --git a/doc/plugin/MouseKeys.md b/docs/plugins/MouseKeys.md similarity index 100% rename from doc/plugin/MouseKeys.md rename to docs/plugins/MouseKeys.md diff --git a/doc/plugin/NumPad.md b/docs/plugins/NumPad.md similarity index 100% rename from doc/plugin/NumPad.md rename to docs/plugins/NumPad.md diff --git a/doc/plugin/OneShot.md b/docs/plugins/OneShot.md similarity index 100% rename from doc/plugin/OneShot.md rename to docs/plugins/OneShot.md diff --git a/doc/plugin/Qukeys.md b/docs/plugins/Qukeys.md similarity index 100% rename from doc/plugin/Qukeys.md rename to docs/plugins/Qukeys.md diff --git a/doc/plugin/Ranges.md b/docs/plugins/Ranges.md similarity index 100% rename from doc/plugin/Ranges.md rename to docs/plugins/Ranges.md diff --git a/doc/plugin/Redial.md b/docs/plugins/Redial.md similarity index 100% rename from doc/plugin/Redial.md rename to docs/plugins/Redial.md diff --git a/doc/plugin/ShapeShifter.md b/docs/plugins/ShapeShifter.md similarity index 100% rename from doc/plugin/ShapeShifter.md rename to docs/plugins/ShapeShifter.md diff --git a/doc/plugin/SpaceCadet.md b/docs/plugins/SpaceCadet.md similarity index 100% rename from doc/plugin/SpaceCadet.md rename to docs/plugins/SpaceCadet.md diff --git a/doc/plugin/Steno.md b/docs/plugins/Steno.md similarity index 100% rename from doc/plugin/Steno.md rename to docs/plugins/Steno.md diff --git a/doc/plugin/Syster.md b/docs/plugins/Syster.md similarity index 100% rename from doc/plugin/Syster.md rename to docs/plugins/Syster.md diff --git a/doc/plugin/TapDance.md b/docs/plugins/TapDance.md similarity index 100% rename from doc/plugin/TapDance.md rename to docs/plugins/TapDance.md diff --git a/doc/plugin/TopsyTurvy.md b/docs/plugins/TopsyTurvy.md similarity index 100% rename from doc/plugin/TopsyTurvy.md rename to docs/plugins/TopsyTurvy.md diff --git a/doc/plugin/TriColor.md b/docs/plugins/TriColor.md similarity index 100% rename from doc/plugin/TriColor.md rename to docs/plugins/TriColor.md diff --git a/doc/plugin/Turbo.md b/docs/plugins/Turbo.md similarity index 100% rename from doc/plugin/Turbo.md rename to docs/plugins/Turbo.md diff --git a/doc/plugin/TypingBreaks.md b/docs/plugins/TypingBreaks.md similarity index 100% rename from doc/plugin/TypingBreaks.md rename to docs/plugins/TypingBreaks.md diff --git a/doc/plugin/USB-Quirks.md b/docs/plugins/USB-Quirks.md similarity index 100% rename from doc/plugin/USB-Quirks.md rename to docs/plugins/USB-Quirks.md diff --git a/doc/plugin/Unicode.md b/docs/plugins/Unicode.md similarity index 100% rename from doc/plugin/Unicode.md rename to docs/plugins/Unicode.md diff --git a/doc/plugin/WinKeyToggle.md b/docs/plugins/WinKeyToggle.md similarity index 100% rename from doc/plugin/WinKeyToggle.md rename to docs/plugins/WinKeyToggle.md diff --git a/docs/conf.py b/etc/docs/conf.py similarity index 95% rename from docs/conf.py rename to etc/docs/conf.py index 7da2f495..f7cc3c28 100644 --- a/docs/conf.py +++ b/etc/docs/conf.py @@ -62,6 +62,13 @@ primary_domain = 'cpp' # Tell sphinx what the pygments highlight language should be. highlight_language = 'cpp' +source_suffix = { + '.rst': 'restructuredtext', + '.txt': 'restructuredtext', +} + + + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -69,7 +76,7 @@ templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'etc'] # -- Options for HTML output ------------------------------------------------- diff --git a/docs/requirements.txt b/etc/docs/requirements.txt similarity index 100% rename from docs/requirements.txt rename to etc/docs/requirements.txt