summaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/api-specification.rst8
-rw-r--r--docs/source/changelog.rst1
-rw-r--r--docs/source/code-of-conduct.rst1
-rw-r--r--docs/source/conf.py4
-rw-r--r--docs/source/contributing.rst1
-rw-r--r--docs/source/index.rst37
-rw-r--r--docs/source/installation.rst38
-rw-r--r--docs/source/license.rst5
-rw-r--r--docs/source/usage.rst2
-rw-r--r--docs/source/using-lirc-on-macos.rst2
-rw-r--r--docs/source/using-lirc-on-windows.rst2
11 files changed, 89 insertions, 12 deletions
diff --git a/docs/source/api-specification.rst b/docs/source/api-specification.rst
new file mode 100644
index 0000000..471325f
--- /dev/null
+++ b/docs/source/api-specification.rst
@@ -0,0 +1,8 @@
+API Specification
+=================
+
+.. automodule:: lirc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
new file mode 100644
index 0000000..6f90edd
--- /dev/null
+++ b/docs/source/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.rst \ No newline at end of file
diff --git a/docs/source/code-of-conduct.rst b/docs/source/code-of-conduct.rst
new file mode 100644
index 0000000..fb1859c
--- /dev/null
+++ b/docs/source/code-of-conduct.rst
@@ -0,0 +1 @@
+.. include:: ../../CODE_OF_CONDUCT.rst \ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 79d1668..9459089 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -18,7 +18,7 @@ sys.path.insert(0, os.path.abspath("../.."))
# -- Project information -----------------------------------------------------
-project = "lirc"
+project = "LIRC Python Package"
copyright = "2020, Eugene Triguba"
author = "Eugene Triguba"
@@ -55,4 +55,4 @@ html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
new file mode 100644
index 0000000..8cb3146
--- /dev/null
+++ b/docs/source/contributing.rst
@@ -0,0 +1 @@
+.. include:: ../../CONTRIBUTING.rst \ No newline at end of file
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
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
new file mode 100644
index 0000000..fa20733
--- /dev/null
+++ b/docs/source/installation.rst
@@ -0,0 +1,38 @@
+Installing the LIRC Python Package
+==================================
+
+Since this package is merely a wrapper around the LIRC
+daemon, it is expected that LIRC is installed and setup
+on the given system as well to be able to use the python
+package.
+
+Python Package
+--------------
+
+This package is hosted on PyPI and can be installed
+through pip.
+
+.. code-block:: bash
+
+ $ pip install lirc
+
+System LIRC Package
+-------------------
+
+While there are ports of LIRC to macOS and Windows,
+the original Linux version is much easier to get
+working and install.
+
+Linux:
+
+ * It is highly likely that the package manager on
+ your system already has LIRC packaged up and ready
+ to be installed for you.
+
+Windows:
+
+ * WinLIRC at http://winlirc.sourceforge.net/ is a port for Windows.
+ It works a bit differently since it is just a collection of files
+ in a folder that you run so you'll have to adjust the ``socket``
+ and ``socket_path`` parameter. More information on that can be found
+ at `Using LIRC on Windows <./using-lirc-on-windows.html>`_. \ No newline at end of file
diff --git a/docs/source/license.rst b/docs/source/license.rst
index 01f3963..2a90cf4 100644
--- a/docs/source/license.rst
+++ b/docs/source/license.rst
@@ -1,4 +1 @@
-License
-=======
-
-.. include:: ../../LICENSE \ No newline at end of file
+.. include:: ../../LICENSE.rst \ No newline at end of file
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
new file mode 100644
index 0000000..9fa12ad
--- /dev/null
+++ b/docs/source/usage.rst
@@ -0,0 +1,2 @@
+Usage
+===== \ No newline at end of file
diff --git a/docs/source/using-lirc-on-macos.rst b/docs/source/using-lirc-on-macos.rst
new file mode 100644
index 0000000..faf5724
--- /dev/null
+++ b/docs/source/using-lirc-on-macos.rst
@@ -0,0 +1,2 @@
+Using LIRC on macOS
+=================== \ No newline at end of file
diff --git a/docs/source/using-lirc-on-windows.rst b/docs/source/using-lirc-on-windows.rst
new file mode 100644
index 0000000..1de244a
--- /dev/null
+++ b/docs/source/using-lirc-on-windows.rst
@@ -0,0 +1,2 @@
+Using LIRC on Windows
+===================== \ No newline at end of file