Skip to content

Commit

Permalink
Explain how to run doctests locally (rdkit#8135)
Browse files Browse the repository at this point in the history
  • Loading branch information
bertiewooster authored Jan 4, 2025
1 parent e6a45a8 commit 498f57a
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion Docs/Book/GettingStartedWithContributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,9 @@ The RDKit docs support inclusion of Sphinx doctests to allow the result of a cod
.. image:: pathtoimage/name.png
```

### How to Build RDKit Documentation Locally
### How to Build and Test RDKit Documentation Locally

#### Build the Documentation

To preview your changes to the RDKit documentation, build the docs locally. First set up your development environment by following the instructions in [Building RDKit for Development](#building-rdkit-for-development). Then change to the directory `Docs/Book`:
```
Expand Down Expand Up @@ -295,6 +297,14 @@ In either case, the output should end with

Now you can preview the docs by pointing your web browser to the local file `rdkit/Docs/Book/_build/html/index.html` where `rdkit` is directory containing the local clone.

#### Test the Documentation

To ensure that code blocks in the documentation return the stated results, you can run doctests locally:

```
make doctest
```

## Contributing to the Code - Python

### Building RDKit for Development
Expand Down

0 comments on commit 498f57a

Please sign in to comment.