Switch to pydata-sphinx-theme

cpp/doc/Doxyfile

@@ -54,7 +54,7 @@ PROJECT_NUMBER         = $(DOLFINX_VERSION)
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "DOLFINx C++ interface"
+PROJECT_BRIEF          = "DOLFINx C++"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55

cpp/doc/source/conf.py

@@ -30,16 +30,14 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "DOLFINx"
+project = "DOLFINx C++"
 now = datetime.datetime.now()
 date = now.date()
 copyright = f"{date.year}, FEniCS Project"
 author = "FEniCS Project"
 
-# TODO: automate version tagging?
-# The full version, including alpha/beta/rc tags
-release = dolfinx.cpp.__version__
-
+version = dolfinx.cpp.__version__
+release = version
 
 # -- General configuration ---------------------------------------------------
 
@@ -73,7 +71,8 @@
 #
 # html_theme = 'alabaster'
 # html_theme = "nature"
-html_theme = "sphinx_rtd_theme"
+html_theme = "pydata_sphinx_theme"
+html_title = f"DOLFINx C++ {release}"
 
 # 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,

cpp/doc/source/demo.rst

@@ -35,3 +35,4 @@ Advanced
    :maxdepth: 1
 
    demos/demo_custom_kernel.md
+   demos/demo_codim_0_assembly.md

cpp/doc/source/index.rst

@@ -1,4 +1,3 @@
-=========================
 DOLFINx C++ documentation
 =========================
 

python/doc/source/conf.py

@@ -3,6 +3,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import datetime
+import importlib.metadata
 import os
 import sys
 
@@ -12,7 +13,6 @@
 import packaging
 
 import basix
-import dolfinx
 import ffcx
 import ufl
 
@@ -63,7 +63,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = "DOLFINx"
+project = "DOLFINx Python"
 now = datetime.datetime.now()
 date = now.date()
 copyright = f"{date.year}, FEniCS Project"
@@ -74,9 +74,8 @@
 # built documents.
 #
 # The short X.Y version.
-version = dolfinx.__version__
-# The full version, including alpha/beta/rc tags.
-release = dolfinx.__version__
+version = importlib.metadata.version("fenics-dolfinx")
+release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -102,7 +101,8 @@
 # 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 = "pydata_sphinx_theme"
+html_title = f"DOLFINx Python {release}"
 
 # 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

python/doc/source/demos.rst

@@ -86,7 +86,7 @@ User-defined and advanced finite elements
 .. toctree::
    :maxdepth: 1
 
-   demos/demo_lagrange_variants.md
+   demos/demo_lagrange-variants.md
    demos/demo_tnt-elements.md
 
 

python/doc/source/index.rst

@@ -1,5 +1,5 @@
-DOLFINx documentation
-=====================
+DOLFINx Python documentation
+============================
 
 DOLFINx is the next generation problem solving interface of the `FEniCS
 Project <https://fenicsproject.org/>`_. It is developed on `GitHub

python/pyproject.toml

@@ -44,7 +44,7 @@ docs = [
       "packaging",
       "pyyaml",
       "sphinx",
-      "sphinx_rtd_theme",
+      "pydata-sphinx-theme",
       "sphinx_codeautolink[ipython]",
       "sphinxcontrib-bibtex",
       "fenics-dolfinx[demo]",