sphinx docs update.

Author: jchanvfx

.github/workflows/sphinx_doc_build.yml

@@ -5,9 +5,9 @@ on:
   release:
     types:
       - published
-#  push:
-#    branches:
-#      - main
+  push:
+    branches:
+      - main
 
 env:
   # environment variables.

README.md

@@ -14,7 +14,7 @@ applications.
 
 ## Install
 
-NodeGraphQt is avaliable on The Python Package Index (PyPI) [here](https://pypi.org/project/NodeGraphQt) so it can be installed with:
+NodeGraphQt is available on The Python Package Index (PyPI) [here](https://pypi.org/project/NodeGraphQt) so it can be installed with:
 ```
 pip install NodeGraphQt
 ```

docs/_static/pygments.css

@@ -11,18 +11,20 @@ td.lineos {
     -moz-box-shadow: none;
 }
 .hll {
-    background-color: #233150:
+    background-color: #233150;
     display: block;
 }
-.code { background: #232629; !important }
+.code {
+    background: #232629; !important;
+}
 .highlight pre {
     background: #0b0d0f !important;
-    border-radius: 10px !important;
+    padding-left: 18px;
 }
 .highlight pre {
     color: #2fb37a;
-    border: 0px; 
-    border-radius: 0px;
+    border: 1px solid #1c2a38;
+    border-radius: 10px;
     -webkit-box-shadow: none;
     -moz-box-shadow: none;
 }

docs/_templates/toc.html

@@ -0,0 +1,14 @@
+{%- if meta is mapping %}
+{%- if "hide-rtoc" not in meta %}
+{#- Template for the on-page TOC -#}
+
+<aside id="right-sidebar" class="hidden text-sm xl:block">
+  <div class="sticky top-16 -mt-10 max-h-[calc(var(--vh)-4rem)] overflow-y-auto pt-6 space-y-2">
+    {%- block toc_before %}{%- endblock -%}
+    <p class="font-medium">Page Contents</p>
+    {{ toc }}
+    {%- block toc_after %}{%- endblock -%}
+  </div>
+</aside>
+{%- endif %}
+{%- endif %}

docs/conf.py

@@ -16,10 +16,14 @@
 import sys
 from datetime import datetime
 
+# make NodeGraphQt module available.
 base_path = os.path.abspath('.')
 root_path = os.path.split(base_path)[0]
 sys.path.insert(0, root_path)
 
+# required for the theme template.
+sys.path.insert(0, os.path.abspath('_themes'))
+
 import NodeGraphQt
 
 # -- Project information -----------------------------------------------------
@@ -52,6 +56,8 @@
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.intersphinx',
     'sphinx.ext.napoleon',
+    # theme template related
+    'sphinxawesome_theme'
 ]
 
 intersphinx_mapping = {
@@ -90,7 +96,7 @@
 '''.format(release)
 
 # Add any paths that contain templates here, relative to this directory.
-# templates_path = ['_templates']
+templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -129,10 +135,6 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
-
-sys.path.insert(0, os.path.abspath('_themes'))
-extensions += ['sphinxawesome_theme']
 
 html_theme = 'sphinxawesome_theme'
 html_theme_path = ['_themes']
@@ -154,11 +156,14 @@
 html_theme_options = {
     # "logo_light": "_images/logo.png",
     # "logo_dark": "_images/logo.png"
-    # # Add your theme options. For example:
-    # 'show_breadcrumbs': True,
-    # 'main_nav_links': {
-    #     'About': '/about',
-    # }
+    'main_nav_links': {
+        'Source': 'https://github.com/jchanvfx/NodeGraphQt',
+        'Issues': 'https://github.com/jchanvfx/NodeGraphQt/issues',
+        'Releases': 'https://github.com/jchanvfx/NodeGraphQt/releases',
+    },
+    'show_scrolltop': True,
+    'show_prev_next': True,
+    'awesome_external_links': True,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -189,19 +194,6 @@
 htmlhelp_basename = 'NodeGraphQTdoc'
 
 
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_elements = {}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 'NodeGraphQT.tex', 'NodeGraphQt Documentation',
-     author, 'manual'),
-]
-
-
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples

docs/custom_widgets.rst

@@ -1,3 +1,5 @@
+:hide-rtoc:
+
 Built-in Widgets
 ################
 

docs/graph.rst

@@ -1,3 +1,5 @@
+:hide-rtoc:
+
 Graphs
 ######
 

docs/host_apps/_index_apps.rst

@@ -7,6 +7,7 @@ Host Application Examples
 .. toctree::
     :name: appstoc
     :maxdepth: 2
+    :titlesonly:
 
     ex_app_nuke
     ex_app_silhouette

docs/index.rst

@@ -2,23 +2,42 @@ NodeGraphQt |version_str|
 #########################
 
 .. image:: _images/logo.png
+    :align: center
 
 NodeGraphQt a node graph UI framework written in python that can be implemented
 and re-purposed into applications supporting PySide2.
 
 .. image:: _images/screenshot.png
-    :width: 95%
 
-|
-| Source: https://github.com/jchanvfx/NodeGraphQt
-| Issue Tracker: https://github.com/jchanvfx/NodeGraphQt/issues
+Install
+*******
+
+NodeGraphQt is available from the `The Python Package Index (PyPI) <https://pypi.org/project/NodeGraphQt/>`_ so
+you can install via ``pip``.
+
+.. code-block::
+
+    pip install NodeGraphQt
+
+or alternatively you can download the source `here <https://github.com/jchanvfx/NodeGraphQt/archive/refs/heads/main.zip>`_.
+
+Getting Started
+***************
+
+To get started see the `basic_example.py <https://github.com/jchanvfx/NodeGraphQt/blob/main/examples/basic_example.py>`_
+script or checkout the :ref:`General Overview` section.
 
 ----
 
+| Source: https://github.com/jchanvfx/NodeGraphQt
+| Issues: https://github.com/jchanvfx/NodeGraphQt/issues
+
 .. toctree::
+    :hidden:
     :caption: API Reference
     :name: apitoc
     :maxdepth: 2
+    :titlesonly:
 
     constants
     graph
@@ -27,6 +46,7 @@ and re-purposed into applications supporting PySide2.
     menu
 
 .. toctree::
+    :hidden:
     :caption: Widgets
     :name: wdgtstoc
     :maxdepth: 1
@@ -35,6 +55,7 @@ and re-purposed into applications supporting PySide2.
     node_widgets
 
 .. toctree::
+    :hidden:
     :caption: Examples
     :name: exmplstoc
     :maxdepth: 1

docs/menu.rst

@@ -1,3 +1,5 @@
+:hide-rtoc:
+
 Menus
 #####