Merge pull request #6 from THATDONFC/docs

Merge current docs changes into dev

.readthedocs.yml

@@ -13,11 +13,11 @@ sphinx:
 #mkdocs:
 #  configuration: mkdocs.yml
 
-# Optionally build your docs in additional formats such as PDF and ePub
-formats: all
+# Don't build any documents (htmlzip, pdf, epub)
+formats: []
 
-# Optionally set the version of Python and requirements required to build your docs
+# Set the version of Python and requirements required to build your docs
 python:
   version: 3.7
   install:
-    - requirements: requirements_docs.txt
+    - requirements: docs/requirements_docs.txt

README.rst

@@ -1,20 +1,54 @@
-LedFx
-================================================================================= 
-|License| |Discord|
+===========
+   LedFx
+===========
+|Build Status| |License| |Build Status Docs| |Discord|
 
-LedFx is a network based LED effect controller with support for advanced real-time audio effects! LedFx can control multiple devices and works great with cheap ESP8266 nodes allowing for cost effectvice syncronized effects across your entire house!
+LedFx is a network based LED effect controller with support for advanced
+real-time audio effects! LedFx can control multiple devices and works great
+with cheap ESP8266/ESP32 nodes allowing for cost effectvice syncronized effects
+across your entire house!
 
-For installation instructions see the `documentation <https://ahodges9.github.io/LedFx/>`__.	
+Installation
+------------
 
-Demos	
----------	
+Basic Linux Installation (Debian/Ubuntu):
 
-We are actively adding and perfecting the effects, but here is a quick demo of LedFx running three different effects synced across three different ESP8266 devices:
+.. code:: console
 
-.. image:: https://raw.githubusercontent.com/ahodges9/LedFx/gh-pages/demos/ledfx_demo.gif
+   $ sudo apt-get install portaudio19-dev
+   $ pip install ledfx
+   $ ledfx --open-ui
+
+For full installation instructions see the `Installation Docs`_.
+
+Configuration
+-------------
+
+LedFx can be configured in a number of ways. To be able
+to add your LED strips to LedFx your device needs to be
+capable of receiving data either via the E1.31 sACN
+protocol or a generic (simple) UDP protocol.
+
+For more information see the `Configuration Docs`_.
+
+.. _`Installation Docs`: https://ledfx.readthedocs.io/en/docs/installing.html
+.. _`Configuration Docs`: https://ledfx.readthedocs.io/en/docs/configuring.html
+
+.. Demos
+.. ---------
+
+.. We are actively adding and perfecting the effects, but here is a quick demo of LedFx running three different effects synced across three different ESP8266 devices:
+
+.. .. image:: https://raw.githubusercontent.com/ahodges9/LedFx/gh-pages/demos/ledfx_demo.gif
 
 .. |Build Status| image:: https://travis-ci.org/ahodges9/LedFx.svg?branch=master
    :target: https://travis-ci.org/ahodges9/LedFx
+   :alt: Build Status
+.. |Build Status Docs| image:: https://readthedocs.org/projects/ledfx/badge/?version=latest
+   :target: https://ledfx.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
 .. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg
+   :alt: License
 .. |Discord| image:: https://img.shields.io/badge/chat-on%20discord-7289da.svg
    :target: https://discord.gg/wJ755dY
+   :alt: Discord

docs/Makefile

@@ -2,8 +2,8 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -b dirhtml
-SPHINXBUILD   = python -msphinx
+SPHINXOPTS    = -a -b dirhtml
+SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = LedFx
 SOURCEDIR     = .
 BUILDDIR      = _build

docs/README.rst

@@ -0,0 +1,34 @@
+--------------------------
+   Document Development
+--------------------------
+
+The documentation is written in reStructuredText. Once you are finished
+making changes, you must build the documentation. To build the LedFx
+documentation follow the steps outlined below:
+
+Linux
+-----
+
+.. code:: bash
+
+    $ cd ~/ledfx/docs
+    $ pip install -r requirements_docs.txt
+    $ make html
+
+macOS
+-----
+
+.. code:: bash
+
+    $ conda activate ledfx
+    $ cd ~/ledfx/docs
+    $ pip install -r requirements_docs.txt
+    $ make html
+
+
+.. Extensions used by sphinx
+
+.. _sphinx.ext.autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
+.. _sphinx.ext.githubpages: https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html
+.. _sphinxcontrib.httpdomain: https://sphinxcontrib-httpdomain.readthedocs.io/en/stable/
+.. _sphinx_rtd_theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/index.html

docs/_static/css/custom.css

@@ -0,0 +1,11 @@
+@import '_build/html/_static/css/theme.css';
+
+.rst-content pre.literal-block, .rst-content div[class^='highlight'] pre, .rst-content .linenodiv pre {
+    /*color of code blocks*/
+    background-color: #EEEEEE
+}
+
+/* Hide "On GitHub" section from versions menu */
+div.rst-versions > div.rst-other-versions > div.injected > dl:nth-child(3) {
+    display: none;
+}

docs/_templates/breadcrumbs.html

@@ -0,0 +1,4 @@
+{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}
+
+{% block breadcrumbs_aside %}
+{% endblock %}