Skip to content

Commit b08addb

Browse files
committed
Fix docs
1 parent ce2510e commit b08addb

File tree

8 files changed

+21
-9
lines changed

8 files changed

+21
-9
lines changed

.conda_create_env/environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: bindflow
1+
name: bindflow-docs
22
channels:
33
- conda-forge
44
dependencies:

docs/conf.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,15 @@
124124
"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/yaml.min.js",
125125
]
126126

127+
128+
# -- Mock heavy or optional dependencies to avoid import errors --
129+
130+
autodoc_mock_imports = [
131+
"pandas",
132+
"toff",
133+
"parmed"
134+
]
135+
127136
intersphinx_mapping = {'Python': ('https://docs.python.org/3/', None),
128137
'numpy': ('https://numpy.org/doc/stable/', None),
129138
'rdkit': ('https://www.rdkit.org/docs/', None),

docs/source/guides/performance/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Plugging into Eq. {eq}`fep_estimation`:
5454
- {math}`T_E=` average time (in hours) to complete the production equilibration simulation
5555
- {math}`T_S=` average time (in hours) to complete the sample simulation
5656
57-
This formula provides a lower bound for the execution time. In practice, you should account for an additional ± 0.2 days to accommodate for the remaining tasks, scheduling overheads and runtime variations. Nevertheless, this estimation is usually reliable, as the total time is dominated by the FEP complex simulations. The value of {math}`T_E` and {math}`T_S` can be determined either from preliminary test runs or by monitoring ongoing simulations
57+
This formula provides a lower bound for the execution time. In practice, you should account for an additional ± 0.2 days to accommodate for the remaining tasks, scheduling overheads and runtime variations. Nevertheless, this estimation is usually reliable, as the total time is dominated by the production MD steps. The value of {math}`T_E` and {math}`T_S` can be determined either from preliminary test runs or by monitoring ongoing simulations
5858
5959
````{dropdown} Example Calculation
6060
:color: info

docs/source/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ We would like to work in a more relaxed environment, but we have encountered cha
1818
1919
<div>
2020
<strong>Features:</strong><br>
21-
<label><input type="checkbox" data-feature="mmpbsa"> MM(P/G)BSA capabilities</label>
21+
<label><input type="checkbox" data-feature="mmpbsa"> MM(PB/GB)SA capabilities</label>
2222
<label><input type="checkbox" data-feature="espaloma"> Espaloma force field</label>
2323
</div>
2424
@@ -159,7 +159,7 @@ If `GROMACS >= 2023`, BindFlow throws a clean error at the very beginning of the
159159

160160
## Documentation dependencies
161161

162-
This project has an [Sphinx](https://www.sphinx-doc.org/en/master/) documentation that can be built and accessed locally.
162+
This online [Sphinx](https://www.sphinx-doc.org/en/master/) documentation can also be built and accessed locally.
163163

164164
````{admonition} requirements_doc.txt
165165
:class: tip

docs/source/modules/data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Data
22

3-
This is sub-packege for testing.
3+
This is sub-package for testing.

docs/source/modules/mdp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
.. automodule:: bindflow.mdp.mdp
55
:members:
66
:special-members: __init__, __call__
7-
```{eval-rst}
7+
```

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ dependencies = [
4848
"numpy",
4949
"pandas",
5050
"mdanalysis",
51-
# "TOFF >= 0.2.0",
5251
"pyyaml",
5352
]
5453

requirements_docs.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,9 @@ sphinxcontrib-katex
77
sphinxcontrib-mermaid
88
sphinx-inline-tabs
99
sphinx_copybutton
10-
sphinx-autobuild
11-
roman
10+
roman
11+
12+
# 🔧 Live-reload server (pin stable versions to avoid asyncio crash)
13+
sphinx-autobuild==2021.3.14
14+
uvicorn<0.30
15+
watchfiles<0.20

0 commit comments

Comments
 (0)