Skip to content

Commit

Permalink
🩹 Fix doc tests
Browse files Browse the repository at this point in the history
  • Loading branch information
boisgera committed Jul 27, 2024
1 parent 27f3cdc commit d0a01e1
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 9 deletions.
4 changes: 2 additions & 2 deletions mkdocs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ from pandoc.types import *
>>> config # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
{'auto': True,
'path': ...,
'version': '3.2',
'version': '3.2.1',
'pandoc_types_version': '1.23.1'}
```
To avoid this, call `pandoc.configure(...)` yourself beforehand.
Expand All @@ -366,7 +366,7 @@ from pandoc.types import *
>>> pandoc.configure(read=True) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
{'auto': False,
'path': ...,
'version': '3.2',
'version': '3.2.1',
'pandoc_types_version': '1.23.1'}
```

Expand Down
4 changes: 2 additions & 2 deletions mkdocs/api.md.template
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ from pandoc.types import *
>>> config # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
{'auto': True,
'path': ...,
'version': '3.2',
'version': '3.2.1',
'pandoc_types_version': '1.23.1'}
```
To avoid this, call `pandoc.configure(...)` yourself beforehand.
Expand All @@ -366,7 +366,7 @@ from pandoc.types import *
>>> pandoc.configure(read=True) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
{'auto': False,
'path': ...,
'version': '3.2',
'version': '3.2.1',
'pandoc_types_version': '1.23.1'}
```

Expand Down
2 changes: 1 addition & 1 deletion mkdocs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ but returns a dictionary whose keys are `auto`, `path`,
>>> pandoc.configure(read=True) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
{'auto': True,
'path': ...,
'version': '3.2',
'version': '3.2.1',
'pandoc_types_version': '1.23.1'}
```

Expand Down
6 changes: 4 additions & 2 deletions mkdocs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,13 +191,15 @@ $$f(z) = \frac{1}{i2\pi} \int \frac{f(w)}{w-z}\, dw$$
``` pycon
>>> doc = pandoc.read(markdown)
>>> print(pandoc.write(doc, format="latex")) # doctest: +NORMALIZE_WHITESPACE
\leavevmode\vadjust pre{\hypertarget{cauchy-formula}{}}%
\phantomsection\label{cauchy-formula}
\[f(z) = \frac{1}{i2\pi} \int \frac{f(w)}{w-z}\, dw\]
>>> theoremize(doc)
>>> print(pandoc.write(doc, format="latex")) # doctest: +NORMALIZE_WHITESPACE
\hypertarget{cauchy-formula}{}
\phantomsection\label{cauchy-formula}
\begin{theorem}\label{cauchy-formula}
<BLANKLINE>
\[f(z) = \frac{1}{i2\pi} \int \frac{f(w)}{w-z}\, dw\]
<BLANKLINE>
\end{theorem}
```

Expand Down
4 changes: 2 additions & 2 deletions mkdocs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Hello Python!
!!! warning
This documentation is dedicated to the [latest version of the project
available on github](https://github.com/boisgera/pandoc).
It is automatically tested with Python 3.12.4 against pandoc 3.2.
It is automatically tested with Python 3.12.4 against pandoc 3.2.1.
At the moment I am writing this,
[the latest release of pandoc for conda](https://anaconda.org/conda-forge/pandoc)
is pandoc 3.2.
is pandoc 3.2.1.

0 comments on commit d0a01e1

Please sign in to comment.