Skip to content

Commit 8f067f3

Browse files
TorkelEisaacsas
andauthored
Update docs/src/devdocs/dev_guide.md
Co-authored-by: Sam Isaacson <[email protected]>
1 parent f92146f commit 8f067f3

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/src/devdocs/dev_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Catalyst release branch*.
3737
## Development advice
3838
3939
### Checking doc builds for errors
40-
When updating documentation, Catalyst will run any Julia code provided within it to dynamically create figures and outputs. In addition to automatically creating these for us, it also provides an automatic check that all code in documentation is correct. Here, if any of the documentation code throws an error, the build job will fail. The documentation build job can be found at the bottom of a PRs conversation, here is an example of a failed one:
40+
When updating documentation, Catalyst will run any Julia code provided within example blocks to dynamically create figures and outputs. In addition to automatically creating these for us, it also provides an automatic check that all code in documentation is correct. Here, if any of the documentation code throws an error, the build job will fail. The documentation build job can be found at the bottom of a PRs conversation, here is an example of a failed one:
4141
![Failed builddocs link](../assets/devdocs/failed_builddocs_link.png)
4242
To check what errors were produced, clock on the "Details" link of the job. Next, any errors can be found at the bottom of the "Build and deploy" section (which should be opened automatically).
4343

0 commit comments

Comments
 (0)