diff --git a/docs/source/RMK_support.rst b/docs/source/RMK_support.rst index 6842661..6f6551a 100644 --- a/docs/source/RMK_support.rst +++ b/docs/source/RMK_support.rst @@ -71,7 +71,7 @@ common\_models submodule :show-inheritance: common\_variables submodule ------------------------- +--------------------------- .. automodule:: RMK_support.common_variables :members: @@ -132,4 +132,4 @@ tex\_parsing submodule .. automodule:: RMK_support.tex_parsing :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/source/_static/thumbnail_ReMKiT1D_black.png b/docs/source/_static/thumbnail_ReMKiT1D_black.png new file mode 100644 index 0000000..1c1a510 Binary files /dev/null and b/docs/source/_static/thumbnail_ReMKiT1D_black.png differ diff --git a/docs/source/_static/thumbnail_ReMKiT1D_white.png b/docs/source/_static/thumbnail_ReMKiT1D_white.png new file mode 100644 index 0000000..24b27c5 Binary files /dev/null and b/docs/source/_static/thumbnail_ReMKiT1D_white.png differ diff --git a/docs/source/conf.py b/docs/source/conf.py index b2d857a..ea7bdb2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,23 +6,30 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'ReMKiT1D Python Support' -copyright = '2023, Stefan Mijin' -author = 'Stefan Mijin' -release = '2.0.0' +project = "ReMKiT1D Python Support" +copyright = "2023, UKAEA" +author = "Stefan Mijin" +release = "2.0.0" import os import sys -sys.path.insert(0, os.path.abspath('../..')) + +sys.path.insert(0, os.path.abspath("../..")) # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = ['sphinx.ext.autodoc','sphinx.ext.napoleon','sphinx.ext.mathjax',"nbsphinx","nbsphinx_link"] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.napoleon", + "sphinx.ext.mathjax", + "nbsphinx", + "nbsphinx_link", +] napoleon_google_docstring = True -nbsphinx_execute = 'never' +nbsphinx_execute = "never" -templates_path = ['_templates'] +templates_path = ["_templates"] exclude_patterns = [] add_module_names = False @@ -30,21 +37,31 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'pydata_sphinx_theme' -html_static_path = ['_static'] +html_theme = "pydata_sphinx_theme" +html_static_path = ["_static"] + +html_sidebars = {"**": ["globaltoc.html"]} html_theme_options = { "navbar_start": ["navbar-logo"], "navbar_align": "left", "primary_sidebar_end": [], "navigation_depth": 0, - "show_nav_level": 3 + "show_nav_level": 3, + "logo": { + "text": "", + "image_light": "_static/thumbnail_ReMKiT1D_black.png", + "image_dark": "_static/thumbnail_ReMKiT1D_white.png", + }, } + def skip(app, what, name, obj, would_skip, options): if name == "__init__": return False return would_skip + def setup(app): - app.connect("autodoc-skip-member", skip) \ No newline at end of file + app.connect("autodoc-skip-member", skip) +