From 8b091210ef215a4f3bf45d2177c7cbaa86793ec7 Mon Sep 17 00:00:00 2001 From: Timothy Nunn Date: Fri, 6 Mar 2026 08:48:52 +0000 Subject: [PATCH] Improve API doc layout --- docs/source/conf.py | 2 +- docs/source/pyvmcon.rst | 15 +++++++++------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index f6cb20b..5e60d62 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,7 +1,7 @@ # -- Project information ----------------------------------------------------- project = "PyVMCON" -copyright = "2023-2025, UK Atomic Energy Authority" +copyright = "2023-present, UK Atomic Energy Authority" author = "Timothy Nunn" # The full version, including alpha/beta/rc tags diff --git a/docs/source/pyvmcon.rst b/docs/source/pyvmcon.rst index 1c44d80..5ff5c3e 100644 --- a/docs/source/pyvmcon.rst +++ b/docs/source/pyvmcon.rst @@ -5,15 +5,18 @@ pyvmcon.vmcon module -------------------- .. automodule:: pyvmcon.vmcon - :members: + :members: solve + +pyvmcon.problem module +---------------------- +.. automodule:: pyvmcon.problem + :members: Problem, Result, AbstractProblem :undoc-members: :show-inheritance: - :exclude-members: solve - -Module contents ---------------- -.. automodule:: pyvmcon +pyvmcon.exceptions module +------------------------- +.. automodule:: pyvmcon.exceptions :members: :undoc-members: :show-inheritance: