Skip to content

Commit 26eeeaf

Browse files
committed
Fix API reference
1 parent 517ec27 commit 26eeeaf

File tree

3 files changed

+11
-12
lines changed

3 files changed

+11
-12
lines changed

docs/requirements.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
sphinx>=4.3.0
22
sphinx-rtd-theme>=0.5.1
3-
sphinx-toolbox>=v0.8.0
4-
3+
sphinx-toolbox>=0.8.0

docs/source/conf.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,19 @@
55

66
# Import mock modules for readthedocs
77
autodoc_mock_imports = [
8+
"__future__",
89
"datetime",
9-
"pandas",
10+
"re",
11+
"contextily",
12+
"geopandas",
1013
"gurobipy",
1114
"highspy",
1215
"networkx",
13-
"numpy",
14-
"matplotlib.pyplot",
16+
"matplotlib",
1517
"math",
16-
"__future__",
17-
"re",
18+
"numpy",
19+
"pandas",
20+
"shapely",
1821
]
1922

2023
# -- Project information
@@ -59,10 +62,7 @@
5962
# -- Options for HTML output
6063

6164
html_theme = "sphinx_rtd_theme"
62-
html_theme_options = {
63-
"version": "",
64-
"release": "",
65-
}
65+
html_theme_options = {"version": "", "release": "", "navigation_depth": 2}
6666

6767
html_context = {
6868
"display_github": True, # Add 'Edit on Github' link instead of 'View page source'

src/pownet/data_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ def get_fuel_mix_order() -> list[str]:
399399
400400
Returns
401401
list[str]: The order of fuel mix.
402-
-------
402+
403403
"""
404404
return pd.read_csv(
405405
os.path.join(get_database_dir(), "fuels.csv"),

0 commit comments

Comments
 (0)