Changes to the documentation index page (#3)

* Added documentation preamble, and set default theme to rtd standard * Added additional links and support sections to the index * Extended intro, and linked to the nx package docs * Slightly improve the index page
nx-python · May 15, 2018 · d20e944 · d20e944
1 parent 34956df
commit d20e944
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -77,7 +77,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,8 +3,21 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to nx's documentation!
+nx-python Documentation
 ==============================
+The nx package comes bundled with PyNX and is available to use in your Python homebrew applications. It allows you to access Switch-specific elements, such as buttons, audio etc., via a high-level, object-oriented wrapper around libnx.
+
+Support
+----------------------
+
+* For module specific info, try the :ref:`genindex` or :doc:`nx`.
+* For any help or further assistance please visit the `PyNX Discord server`_.
+
+Additional Material
+----------------------
+* `libnx documentation <https://switchbrew.github.io/libnx/index.html>`_
+
+.. _PyNX Discord server: https://discord.gg/HDp5H4
 
 .. toctree::
    :maxdepth: 2