Fix and improve RTD page (#108)

AstarVienna · Nov 13, 2024 · c84275e · c84275e
2 parents efd3671 + 519700c
commit c84275e
Show file tree

Hide file tree

Showing 39 changed files with 933 additions and 1,374 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,16 +21,11 @@
 
 sys.path.insert(0, os.path.abspath('../'))
 
-#if "TRAVIS" in os.environ:
-package_path = os.path.abspath('../..')
-os.environ['PYTHONPATH'] = ':'.join((package_path,
-                                     os.environ.get('PYTHONPATH', '')))
-
 
 # -- Project information -----------------------------------------------------
 
 project = 'ScopeSim_templates'
-copyright = '2021, A* Vienna'
+copyright = '2024, A* Vienna'
 author = 'A* Vienna'
 
 # The short X.Y version
@@ -48,15 +43,6 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-#extensions = [
-#    'sphinx.ext.autodoc',
-#    'sphinx.ext.doctest',
-#    'sphinx.ext.intersphinx',
-#    'sphinx.ext.todo',
-#    'sphinx.ext.coverage',
-#    'sphinx.ext.mathjax',
-#    'sphinx.ext.viewcode',
-#]
 
 
 extensions = [
@@ -66,11 +52,10 @@
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.mathjax',
     'sphinx.ext.extlinks',
-#    'sphinx.ext.linkcode',
-#    'jupyter_sphinx',
     'sphinx.ext.doctest',
+    'sphinx_copybutton',
+    'myst_nb',
     'numpydoc',
-    'nbsphinx',
     ]
 
 # -- Options for intersphinx extension ---------------------------------------
@@ -118,10 +103,19 @@
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
-source_encoding = 'utf-8-sig'
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".ipynb": "myst-nb",
+    ".myst": "myst-nb",
+    ".md": "myst-nb",
+}
+source_encoding = 'utf-8'
+
+# MyST NB stuff
+nb_execution_timeout = 3600  # [s]
+nb_execution_mode = "auto"
+# nb_execution_excludepatterns = []
+
 
 # The master toctree document.
 master_doc = 'index'
@@ -147,41 +141,38 @@
 
 pygments_style = 'default' #'sphinx'
 
-# -- Options for HTML output ---------------------------------------------------
 
-html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-# html_theme = 'alabaster'
+# -- Options for HTML output ----------------------------------------------
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
+html_theme = "sphinx_book_theme"
+html_theme_options = {
+    "repository_url": "https://github.com/AstarVienna/ScopeSim_Templates",
+    "use_repository_button": True,
+    "use_download_button": True,
+    "home_page_in_toc": True,
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['docs/_static']
+# html_logo = 'docs/_static/logos/T_favicon.png'
+html_title = "ScopeSim Templates"
 
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# The default sidebars (for documents that don't match any pattern) are
-# defined by theme itself.  Builtin themes are using these templates by
-# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
-# 'searchbox.html']``.
-#
-# html_sidebars = {}
 
+# Add local templates path to modify autosummary templates
+# templates_path = ['_templates']
+
+# Static files to copy after template files
+html_static_path = ['_static']
+html_sidebars = {
+    "**": [
+        "navbar-logo.html",
+        "search-field.html",
+        "sbt-sidebar-nav.html",
+    ]
+}
+html_sourcelink_suffix = ""
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
@@ -235,7 +226,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'ScopeSim_templates', 'ScopeSim Templates Documentation',
-     author, 'ScopeSim_templates', 
+     author, 'ScopeSim_templates',
      'Helper functions for creating ScopeSim Source objects.',
      'Miscellaneous'),
 ]

diff --git a/docs/contributions.rst b/docs/contributions.rst
diff --git a/docs/generated/scopesim_templates.calibration.empty_sky.rst b/docs/generated/scopesim_templates.calibration.empty_sky.rst
diff --git a/docs/generated/scopesim_templates.calibration.flat_field.rst b/docs/generated/scopesim_templates.calibration.flat_field.rst
diff --git a/docs/generated/scopesim_templates.calibration.lamp.rst b/docs/generated/scopesim_templates.calibration.lamp.rst
diff --git a/docs/generated/scopesim_templates.extragalactic.elliptical.rst b/docs/generated/scopesim_templates.extragalactic.elliptical.rst
diff --git a/docs/generated/scopesim_templates.extragalactic.galaxy.rst b/docs/generated/scopesim_templates.extragalactic.galaxy.rst
diff --git a/docs/generated/scopesim_templates.extragalactic.galaxy3d.rst b/docs/generated/scopesim_templates.extragalactic.galaxy3d.rst
diff --git a/docs/generated/scopesim_templates.extragalactic.spiral_two_component.rst b/docs/generated/scopesim_templates.extragalactic.spiral_two_component.rst
diff --git a/docs/generated/scopesim_templates.misc.point_source.rst b/docs/generated/scopesim_templates.misc.point_source.rst
diff --git a/docs/generated/scopesim_templates.misc.source_from_array.rst b/docs/generated/scopesim_templates.misc.source_from_array.rst
diff --git a/docs/generated/scopesim_templates.misc.source_from_cube.rst b/docs/generated/scopesim_templates.misc.source_from_cube.rst
diff --git a/docs/generated/scopesim_templates.misc.source_from_file.rst b/docs/generated/scopesim_templates.misc.source_from_file.rst
diff --git a/docs/generated/scopesim_templates.misc.source_from_imagehdu.rst b/docs/generated/scopesim_templates.misc.source_from_imagehdu.rst
diff --git a/docs/generated/scopesim_templates.misc.source_from_imagehdu_with_flux.rst b/docs/generated/scopesim_templates.misc.source_from_imagehdu_with_flux.rst
diff --git a/docs/generated/scopesim_templates.misc.uniform_source.rst b/docs/generated/scopesim_templates.misc.uniform_source.rst
diff --git a/docs/generated/scopesim_templates.stellar.cluster.rst b/docs/generated/scopesim_templates.stellar.cluster.rst
diff --git a/docs/generated/scopesim_templates.stellar.star.rst b/docs/generated/scopesim_templates.stellar.star.rst
diff --git a/docs/generated/scopesim_templates.stellar.star_field.rst b/docs/generated/scopesim_templates.stellar.star_field.rst
diff --git a/docs/generated/scopesim_templates.stellar.star_grid.rst b/docs/generated/scopesim_templates.stellar.star_grid.rst
diff --git a/docs/generated/scopesim_templates.stellar.stars.rst b/docs/generated/scopesim_templates.stellar.stars.rst