Skip to content

Commit

Permalink
Modified conf.py to enable external project links in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
wehs7661 committed Apr 18, 2024
1 parent d61e0d1 commit bf5da7e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'nbsphinx',
]
Expand Down Expand Up @@ -183,4 +184,9 @@
# -- Others ------------------------------------------------------------------
autodoc_default_options = {
'private-members': True,
}

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
"pymbar": ("https://pymbar.readthedocs.io/en/latest/", None),
}
2 changes: 1 addition & 1 deletion ensemble_md/analysis/analyze_free_energy.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def preprocess_data(files_list, temp, data_type, spacing=1, t=None, g=None):
For each replica, it reads in :math:`u_{nk}`/:math:`dH/dλ` data from all iterations, concatenate
them, remove the equilibrium region and and decorrelate the concatenated data. Notably,
the data preprocessing protocol is basically the same as the one adopted in
:code:`alchemlyb.subsampling.equilibrium_detection`.
:func:`alchemlyb.subsampling.equilibrium_detection`.
Parameters
----------
Expand Down

0 comments on commit bf5da7e

Please sign in to comment.