Skip to content

Fix Sphinx documentation build errors #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RoryBarnes merged 1 commit into from
Jan 3, 2026
Merged

Fix Sphinx documentation build errors #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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".
Expand Down
4 changes: 2 additions & 2 deletions docs/help.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
MultiPlanet Documentation
=======
==========================

``multi-planet`` manages the exectution of a suite of `VPLanet <https://github.com/VirtualPlanetaryLaboratory/multi-planet>`_
simulations that were built with `VSPACE <https://github.com/VirtualPlanetaryLaboratory/vspace>`_.
Expand Down
Loading