You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-3Lines changed: 31 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -154,14 +154,42 @@ The pytest plugin enables the use of `scipy_doctest` tools to perform doctests.
154
154
155
155
Follow the given instructions to utilize the pytest plugin for doctesting.
156
156
157
-
### Running Doctests on Packages/Projects
157
+
### Running Doctests on SciPy
158
+
159
+
1.**Install plugin**
160
+
161
+
```bash
162
+
pip install scipy-doctest
163
+
```
164
+
165
+
2.**Configure Your Doctesting Experience**
166
+
167
+
To tailor your doctesting experience, you can utilize an instance of `DTConfig`.
168
+
An in-depth explanation is given in the [tailoring your doctesting experience](https://github.com/scipy/scipy_doctest#tailoring-your-doctesting-experience) section.
169
+
170
+
3.**Run Doctests**
171
+
172
+
Doctesting is configured to execute on SciPy using the `dev.py` module.
173
+
174
+
To run all doctests, use the following command:
175
+
```bash
176
+
python dev.py smoke-docs
177
+
```
178
+
179
+
To run doctests on specific SciPy modules, e.g: `cluster`, use the following command:
180
+
181
+
```bash
182
+
python dev.py smoke-docs -s cluster
183
+
```
184
+
185
+
### Running Doctests on Other Packages/Projects
158
186
159
187
If you want to run doctests on packages or projects other than SciPy, follow these steps:
If you don't set these attributes, the [default settings](https://github.com/scipy/scipy_doctest/blob/58ff06a837b7bff1dbac6560013fc6fd07952ae2/scipy_doctest/impl.py#L94) of the attributes are used.
245
273
246
-
By following these steps, you will be able to effectively use the Scpdt pytest plugin for doctests in your Python projects.
274
+
By following these steps, you will be able to effectively use the SciPy Doctest pytest plugin for doctests in your Python projects.
0 commit comments