Skip to content

Commit b930ef4

Browse files
committed
Inform on docutils compatibility.
1 parent 2024938 commit b930ef4

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ A Python library with some [docutils](https://www.docutils.org/) helpers used by
1414

1515
antsibull-docutils is covered by the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
1616

17+
## Docutils support
18+
19+
In CI, compatibility with docutils 0.18+ is tested. Older versions of docutils might work as well, depending on your use-case. The tests do not pass for 0.16 and 0.17, as these versions emit different IDs and HTML (for tables). 0.16 also handles code blocks differently, and they will not be emitted with the MarkDown renderer.
20+
1721
## Development
1822

1923
Install and run `nox` to run all tests. That's it for simple contributions!

0 commit comments

Comments
 (0)