From 2caf55a435348e73b9f42e1329deff7eefd799c4 Mon Sep 17 00:00:00 2001 From: Lewis Crichton Date: Sat, 9 Jun 2018 20:10:10 +0100 Subject: [PATCH] update docs again --- docs/conf.py | 3 ++- docs/help.rst | 5 +++-- docs/highlight-updates.rst | 5 +++-- docs/index.rst | 5 +++++ docs/installing-commander.rst | 4 ++++ docs/version.rst | 3 ++- 6 files changed, 19 insertions(+), 6 deletions(-) create mode 100644 docs/installing-commander.rst diff --git a/docs/conf.py b/docs/conf.py index a61c03c..332019a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -82,7 +82,8 @@ # documentation. # html_theme_options = { - 'logo_only': True + 'logo_only': True, + 'display_version': False } # Add any paths that contain custom static files (such as style sheets) here, diff --git a/docs/help.rst b/docs/help.rst index d21c932..85b782c 100644 --- a/docs/help.rst +++ b/docs/help.rst @@ -7,9 +7,10 @@ Brings you to the ReadTheDocs page, or the page for the command specified. | Parameter | Description | +===========+============================================================+ | command | The command to automatically go to on the doucmentation. | -+------------------------------------------------------------------------+ ++-----------+------------------------------------------------------------+ Usage ----- -.. code:: +.. code-block:: text + # help [command (optional)] \ No newline at end of file diff --git a/docs/highlight-updates.rst b/docs/highlight-updates.rst index a85d538..18d2907 100644 --- a/docs/highlight-updates.rst +++ b/docs/highlight-updates.rst @@ -7,9 +7,10 @@ Highlights whenever an element updates with a red outline that disappears after | Parameter | Description | +===========+============================================================+ | toggled | Toggles whether Commander should highlight updates or not. | -+------------------------------------------------------------------------+ ++-----------+------------------------------------------------------------+ Usage ----- -.. code:: +.. code-block:: text + # highlight-updates [toggled] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index c525068..5e8d454 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,12 +3,17 @@ Commander Welcome to the documentation for Commander! +.. _commander-docs: + .. toctree:: :maxdepth: 2 :caption: Commander + installing-commander using-commander +.. _commands: + .. toctree:: :maxdepth: 2 :caption: Commands diff --git a/docs/installing-commander.rst b/docs/installing-commander.rst new file mode 100644 index 0000000..80db6fc --- /dev/null +++ b/docs/installing-commander.rst @@ -0,0 +1,4 @@ +Installing Commander +==================== + +To install Commander, enable the Developer Mode option clone the `GitHub repository `_ \ No newline at end of file diff --git a/docs/version.rst b/docs/version.rst index be5c1ee..2b34987 100644 --- a/docs/version.rst +++ b/docs/version.rst @@ -5,5 +5,6 @@ Shows you the version of Commander you're running in a popup. Usage ----- -.. code:: +.. code-block:: text + # version \ No newline at end of file