Skip to content

Commit d20e944

Browse files
HarryPeachAileenLumina
authored andcommitted
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
1 parent 34956df commit d20e944

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
# The theme to use for HTML and HTML Help pages. See the documentation for
7878
# a list of builtin themes.
7979
#
80-
html_theme = 'alabaster'
80+
html_theme = 'sphinx_rtd_theme'
8181

8282
# Theme options are theme-specific and customize the look and feel of a theme
8383
# further. For a list of options available for each theme, see the

docs/index.rst

+14-1
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,21 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to nx's documentation!
6+
nx-python Documentation
77
==============================
8+
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.
9+
10+
Support
11+
----------------------
12+
13+
* For module specific info, try the :ref:`genindex` or :doc:`nx`.
14+
* For any help or further assistance please visit the `PyNX Discord server`_.
15+
16+
Additional Material
17+
----------------------
18+
* `libnx documentation <https://switchbrew.github.io/libnx/index.html>`_
19+
20+
.. _PyNX Discord server: https://discord.gg/HDp5H4
821

922
.. toctree::
1023
:maxdepth: 2

0 commit comments

Comments
 (0)