change the docs theme to sphinx_book_theme (#229)

this renders the notebooks better also allows for dark mode and more links back to github
python-hydro · Sep 1, 2024 · 5834466 · 5834466
1 parent 91721f7
commit 5834466
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 63 deletions.
diff --git a/docs/source/_static/myfile.css b/docs/source/_static/myfile.css
@@ -0,0 +1,10 @@
+@import url('https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,100;0,300;0,400;0,700;0,900;1,100;1,300;1,400;1,700;1,900&display=swap');
+@import url('https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,300;0,400;0,500;0,600;0,700;1,300;1,400;1,500;1,600;1,700&display=swap');
+
+body {
+    font-family: "Open Sans", sans-serif;
+}
+
+.heading-style, h1, h2, h3, h4, h5, h6 {
+    font-family: "Open Sans", sans-serif;
+}
diff --git a/docs/source/_static/theme_overrides.css b/docs/source/_static/theme_overrides.css
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -45,7 +45,6 @@
     'sphinx.ext.graphviz',
     'sphinx_copybutton',
     'sphinx-prompt',
-    'sphinx_rtd_theme',
     'IPython.sphinxext.ipython_console_highlighting',
     'sphinx.ext.githubpages']
 
@@ -72,10 +71,11 @@
 
 # General information about the project.
 project = 'pyro'
-copyright = '2023, pyro development team'
+copyright = '2024, pyro development team'
 author = 'pyro development team'
 
 html_logo = "logo.gif"
+html_title = "pyro"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -110,32 +110,40 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'sphinx_book_theme'
 
 # 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_options = {
+    "repository_url": "https://github.com/python-hydro/pyro2",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+    "use_source_button": True,
+    "repository_branch": "main",
+    "path_to_docs": "docs/source"
+}
 
 # 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_css_files = ["theme_overrides.css"]
+html_css_files = ["myfile.css"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
-    '**': [
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
-    ]
-}
+#html_sidebars = {
+#    '**': [
+#        'relations.html',  # needs 'show_related': True theme option to display
+#        'searchbox.html',
+#    ]
+#}
 
 linkcheck_ignore = [r"https://ascelibrary.org",
                     r"https://doi.org/10.1061/(ASCE)0733-9429(1999)125:11(1210)",

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,9 +11,17 @@ pyro: a python hydro code
 
 .. image:: pyro_plots.png
 
+About
+=====
+
+pyro is a python hydrodynamics code meant to illustrate how the basic methods
+used in astrophysical simulations work.  It is also used for prototyping
+new ideas.
+
 .. toctree::
    :maxdepth: 1
    :caption: pyro basics
+   :hidden:
 
    intro
    installation
@@ -26,6 +34,7 @@ pyro: a python hydro code
 .. toctree::
    :maxdepth: 1
    :caption: Mesh
+   :hidden:
 
    mesh_basics
    mesh-examples.ipynb
@@ -34,6 +43,7 @@ pyro: a python hydro code
 .. toctree::
    :maxdepth: 1
    :caption: Solvers
+   :hidden:
 
    advection_basics
    burgers_basics
@@ -50,31 +60,36 @@ pyro: a python hydro code
 .. toctree::
    :maxdepth: 1
    :caption: Examples
+   :hidden:
 
    compressible-convergence.ipynb
 
 .. toctree::
    :maxdepth: 1
    :caption: Utilities
+   :hidden:
 
    analysis
    testing
 
 .. toctree::
    :maxdepth: 1
    :caption: Community
+   :hidden:
 
    help
    ack
 
 .. toctree::
    :maxdepth: 1
    :caption: Software Reference
+   :hidden:
 
    API <modules>
 
 .. toctree::
    :caption: Bibliography
+   :hidden:
 
    zreferences
 
@@ -84,4 +99,3 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
@@ -3,6 +3,8 @@ Introduction to pyro
 
 .. image:: pyro_plots.png
 
+|
+
 pyro is a simple framework for implementing and playing with
 hydrodynamics solvers.  It is designed to provide a tutorial for
 students in computational astrophysics (and hydrodynamics in general)

diff --git a/requirements.txt b/requirements.txt
@@ -2,7 +2,7 @@ numpy>=1.13.3
 matplotlib>=2.0.0
 h5py>=2.7
 scipy>=0.16
-sphinx_rtd_theme
+sphinx_book_theme
 nbsphinx>=0.3.1
 pytest>=3.6
 nbval>=0.9.0