Skip to content

Commit 298086c

Browse files
committed
work on fixing sphinx docs
1 parent 8c9b0c4 commit 298086c

File tree

3 files changed

+5
-8
lines changed

3 files changed

+5
-8
lines changed

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,6 @@
115115
autodoc_mock_imports = []
116116

117117
# Example configuration for intersphinx: refer to the Python standard library.
118-
## Add Python version number to the default address to corretcly reference
118+
## Add Python version number to the default address to correctly reference
119119
## the Python standard library
120-
intersphinx_mapping = {"https://docs.python.org/3.8": None}
120+
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

mp_api/client/mprester.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -930,9 +930,7 @@ def get_ion_reference_data(self) -> list[dict]:
930930
'ΔGᶠ': {'display': '-293.71 kJ/mol', 'value': -293.71, 'unit': 'kJ/mol'},
931931
'MajElements': 'Li',
932932
'RefSolid': 'Li2O',
933-
'ΔGᶠRefSolid': {'display': '-561.2 kJ/mol',
934-
'value': -561.2,
935-
'unit': 'kJ/mol'},
933+
'ΔGᶠRefSolid': {'display': '-561.2 kJ/mol', 'value': -561.2, 'unit': 'kJ/mol'},
936934
'reference': 'H. E. Barner and R. V. Scheuerman, Handbook of thermochemical data for
937935
compounds and aqueous species, Wiley, New York (1978)'}}
938936
"""
@@ -971,9 +969,7 @@ def get_ion_reference_data_for_chemsys(self, chemsys: str | list) -> list[dict]:
971969
'ΔGᶠ': {'display': '-293.71 kJ/mol', 'value': -293.71, 'unit': 'kJ/mol'},
972970
'MajElements': 'Li',
973971
'RefSolid': 'Li2O',
974-
'ΔGᶠRefSolid': {'display': '-561.2 kJ/mol',
975-
'value': -561.2,
976-
'unit': 'kJ/mol'},
972+
'ΔGᶠRefSolid': {'display': '-561.2 kJ/mol', 'value': -561.2, 'unit': 'kJ/mol'},
977973
'reference': 'H. E. Barner and R. V. Scheuerman, Handbook of thermochemical data for
978974
compounds and aqueous species, Wiley, New York (1978)'}}
979975
"""

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ test = [
4848
"types-setuptools",
4949
"types-requests",
5050
]
51+
docs = ["sphinx"]
5152

5253
[tool.setuptools.packages.find]
5354
include = ["mp_api*"]

0 commit comments

Comments
 (0)