Skip to content

Commit

Permalink
Docs: Fix the build on ReadTheDocs
Browse files Browse the repository at this point in the history
There was a backtick missing in the `help` attribute of an input port
declaration of the `CalcJob` class. This class is rendered automatically
through our sphinx plugin in the `topics/calculations/usage.rst` file in
the "Options" section. No idea why this didn't fail before this because
this mistake was not introduced in this PR.

Also add config option for `myst-nb` to `conf.py` so that it shows the
stacktrace if an exception is raised during notebook execution.
  • Loading branch information
sphuber committed Dec 12, 2022
1 parent 29a3067 commit 2492152
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion aiida/engine/processes/calcjobs/calcjob.py
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ def define(cls, spec: CalcJobProcessSpec) -> None: # type: ignore[override]
'metadata.options.stash.stash_mode',
valid_type=str,
required=False,
help='Mode with which to perform the stashing, should be value of `aiida.common.datastructures.StashMode.'
help='Mode with which to perform the stashing, should be value of `aiida.common.datastructures.StashMode`.'
)

spec.output(
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@

myst_enable_extensions = ['colon_fence', 'deflist']
myst_heading_anchors = 3
nb_execution_show_tb = 'READTHEDOCS' in os.environ
nb_merge_streams = True
nb_mime_priority_overrides = [
('gettext', 'application/vnd.jupyter.widget-view+json', 0),
Expand Down
2 changes: 1 addition & 1 deletion docs/source/intro/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ $ verdi node graph generate 3

The command will write the provenance graph to a `.pdf` file.
Use your favorite PDF viewer to have a look.
It should look something like the graph shown {ref}`below <fig_calcfun_graph>`.
It should look something like the graph shown below.

```{code-cell} ipython3
---
Expand Down
1 change: 1 addition & 0 deletions docs/source/nitpick-exceptions
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ py:class requests.models.Response
py:class requests.Response

py:class concurrent.futures._base.TimeoutError
py:class concurrent.futures._base.Future

py:class disk_objectstore.utils.LazyOpener

Expand Down

0 comments on commit 2492152

Please sign in to comment.