From 27e72f04580d5d23525b7ee5473a06e800936bb9 Mon Sep 17 00:00:00 2001 From: RoryBarnes Date: Fri, 2 Jan 2026 19:29:50 -0800 Subject: [PATCH] Fix Sphinx documentation build errors MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixed three issues preventing docs from building: 1. Theme compatibility: Removed html_theme_path pointing to outdated local theme - Local sphinx_rtd_theme/ is incompatible with Sphinx 7.x ('style' undefined) - Now uses installed sphinx_rtd_theme package from pip 2. Link reference syntax error in help.rst:18 - Fixed: '.. BigPlanet:' → '.. _BigPlanet:' (missing underscore) - Removed improper indentation 3. Title underline too short in index.rst:2 - Extended underline to match title length (7 → 26 characters) All errors resolved. Docs should now build successfully with Sphinx 7.x. --- docs/conf.py | 2 +- docs/help.rst | 4 ++-- docs/index.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f5bb07c..7647b08 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ # a list of builtin themes. # html_theme = "sphinx_rtd_theme" -html_theme_path = ["."] +# Use the installed sphinx_rtd_theme package, not local copy # 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". diff --git a/docs/help.rst b/docs/help.rst index af9d945..485ce8d 100644 --- a/docs/help.rst +++ b/docs/help.rst @@ -15,9 +15,9 @@ There are three optional arguments for :code:`MultiPlanet`: :code:`-q`: there will be no output in the command line - :code:`-bp`: `BigPlanet`_ will be ran in conjunction with :code:`MultiPlanet`. +:code:`-bp`: `BigPlanet`_ will be ran in conjunction with :code:`MultiPlanet`. - .. BigPlanet: https://github.com/VirtualPlanetaryLaboratory/bigplanet +.. _BigPlanet: https://github.com/VirtualPlanetaryLaboratory/bigplanet :code:`-m`: emails the users at :code:`email` when the simulations are complete diff --git a/docs/index.rst b/docs/index.rst index 92a6621..7405bef 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ MultiPlanet Documentation -======= +========================== ``multi-planet`` manages the exectution of a suite of `VPLanet `_ simulations that were built with `VSPACE `_.