From b0356c332c23d29cebafa648a630caf1e96e05e3 Mon Sep 17 00:00:00 2001 From: RichardFrangenberg Date: Sat, 21 Oct 2023 15:16:34 +0100 Subject: [PATCH] update docs overview --- doc/conf.py | 10 ++++++++++ doc/index.rst | 14 +++++++++++--- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index e42f1766..90cabf6f 100644 --- 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 index b060a98b..bd1a8572 100644 --- 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 `__. + +More information including example scripts can be found in the `Prism User Documentation `__. .. toctree:: :glob: - :maxdepth: 2 + :maxdepth: 1 :caption: Core: autodoc/core/* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Plugins: 3dsMax