summaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-07-12 22:13:14 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-07-12 22:13:14 -0500
commit641f68125f317f736110b71fb9a1b9725d8e3771 (patch)
treec7db87eb35c32e85ad416ab1cf7472f6891b2721 /docs/source/index.rst
parentConvert docs to rst and add CONTRIBUTING guidelines (diff)
downloadlirc-641f68125f317f736110b71fb9a1b9725d8e3771.zip
Add rtd docs
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst37
1 files changed, 31 insertions, 6 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3ec68f9..d47212e 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,20 +1,45 @@
-LIRC Documentation
-==================
+.. include:: ../../README.rst
+
+Site Documentation
+------------------
+
+.. toctree::
+ :caption: Up & Running
+ :maxdepth: 2
+
+ installation
+
+.. toctree::
+ :caption: Package Usage
+ :maxdepth: 2
+
+ usage
+ using-lirc-on-windows
+ using-lirc-on-macos
-LIRC is a python package that allows you to interact with
-the daemon in the Linux Infrared Remote Control package.
+.. toctree::
+ :caption: Reference
+ :maxdepth: 2
-**Table of Contents:**
+ api-specification
+ changelog
+ code-of-conduct
.. toctree::
+ :caption: Legal
:maxdepth: 2
license
+.. toctree::
+ :caption: Development
+ :maxdepth: 2
+
+ contributing
+
Indices and tables
==================
* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search` \ No newline at end of file