Skip to content

Commit

Permalink
update docs again
Browse files Browse the repository at this point in the history
  • Loading branch information
lewisakura committed Jun 9, 2018
1 parent beaf69b commit 2caf55a
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 6 deletions.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
5 changes: 3 additions & 2 deletions docs/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
5 changes: 3 additions & 2 deletions docs/highlight-updates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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]
5 changes: 5 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/installing-commander.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Installing Commander
====================

To install Commander, enable the Developer Mode option clone the `GitHub repository <https://github.com/LewisTehMinerz/Commander>`_
3 changes: 2 additions & 1 deletion docs/version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ Shows you the version of Commander you're running in a popup.

Usage
-----
.. code::
.. code-block:: text
# version

0 comments on commit 2caf55a

Please sign in to comment.