update docs overview

PrismPipeline · Oct 21, 2023 · b0356c3 · b0356c3
1 parent d1daa7c
commit b0356c3
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -59,3 +59,13 @@
 html_theme = 'sphinx_book_theme'
 html_logo = '_static/prism-pipeline-logo.png'
 html_title = 'Prism Pipeline Python API Reference'
+
+html_theme_options = {
+    "home_page_in_toc": True,
+    "use_download_button": True,
+    "use_repository_button": True,
+    "repository_url": "https://github.com/PrismPipeline/Prism",
+    "external_links": [
+        ("Prism", "https://prism-pipeline.com"),
+    ]
+}
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,16 +1,24 @@
+Overview
+========================================================
+
 Welcome to Prism Pipeline's Python API Reference!
-===================================
+-----------------------------------------------------
+
+
+This is an automically generated Python API Reference for `Prism Pipeline <https://prism-pipeline.com>`__.
+
+More information including example scripts can be found in the `Prism User Documentation <https://prism-pipeline.com/docs/latest/>`__.
 
 
 .. toctree::
    :glob:
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Core:
 
    autodoc/core/*
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Plugins:
 
    3dsMax