docs

CharaChorder documentation

Dependencies

Install sphinx, sphinx_rtd_theme, sphinx-design, and myst-parser using pip or your preferred package manager.

pip install sphinx sphinx_rtd_theme myst-parser sphinx-design

Nix/NixOS

With flakes enabled, run nix develop or use nix-direnv with direnv allow

Development

For development, you should also install sphinx-autobuild and then start the dev server using

sphinx-autobuild docs _build

Building

sphinx-build -a docs _build

Note, the -a flag will rebuild all files, regardless of if they have changed. This is useful so that warnings don't get cached. All warnings are preferred to be fixed rather than left, although in some cases (docs don't exist yet) the warnings are fine to leave.

Adding a new top level page

If you are adding or editing an under construction top level page, make sure to add it to index.rst if you'd like to have it shown on the left side bar.

Linking

If you'd like to link to another page (just the page) use something like this:

:doc:`chording<Chords>` 

If you want to link to a specific header in another page or on the same page:

:ref:`startup<GenerativeTextMenu:Startup>`

If you want to link to a specific anchor:

:ref:`slow speed <Slow Speed>`

Tables

.. csv-table::
:header: "Device", "Default", "Min. Value", "Max. Value", "Increments"

    "CharaChorder One", ""
    "CharaChorder Lite", ""
    "CharaChorder X", ""
    "CharaChorder Engine", ""

Dropdown

.. dropdown:: Title of the Dropdown, visible with the DD closed.

    Text inside the dropdown should skip a line then indent once (4 spaces).

Images

.. image:: /assets/images/PATH-TO-IMAGE.png
  :width: 1200
  :alt: Alt text for screen readers