From f425cca4dc30f5282d83fcee8948fdac2f9f904c Mon Sep 17 00:00:00 2001 From: Richard Plevin Date: Wed, 13 Nov 2024 12:52:12 -0800 Subject: [PATCH] - Updated sphinx doc conf.py - Fixed format error in function doc string --- docs/source/conf.py | 4 ++-- opgee/analysis.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 4dae5b9e..8b788e16 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -23,7 +23,7 @@ # -- Project information ----------------------------------------------------- project = 'OPGEE' -copyright = '2022-2023, The Board of Trustees of the Leland Stanford Junior University' +copyright = '2022-2024, The Board of Trustees of the Leland Stanford Junior University' author = 'Adam Brandt, Richard Plevin, Wennan Long' # The short X.Y version. @@ -79,4 +79,4 @@ # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/3/': None} +intersphinx_mapping = {'python' : ('https://docs.python.org/3/', None)} diff --git a/opgee/analysis.py b/opgee/analysis.py index 0740821a..71e611fd 100644 --- a/opgee/analysis.py +++ b/opgee/analysis.py @@ -221,7 +221,7 @@ def from_xml(cls, elt, parent=None, field_names=None): :param elt: (etree.Element) representing a element :param parent: (opgee.Model) the Model containing the new Analysis - :param field_names: (list[str] or None) field names to restrict to, + :param field_names: (list[str] or None) field names to restrict to, otherwise all fields declared in the Analysis are used. :return: (Analysis) instance populated from XML """