mr.docs is a Docker container, which can help you with testing documentation written in Sphinx.
mr.docs is written as a personal tool, to improve the documentation of Plone.
It comes with a pre-configured list 'of good known words' based on typical terms used within Plone.
- Small Image, based on Alpine Linux.
- You do not need to install sphinx locally.
- Pre-configured with different add-ons.
- A new, clean and 'fresh' build with every test run.
- Various checks
Full documentation for end users can be found in the "docs" folder.
You can find the documentation online on Read The Docs.
Pull the image:
docker pull quay.io/tiramisu/mr.docs
If you are having issues, please let us know.
The project is licensed under the GPLv2.