mr.docs¶
A container wrapper based on Alpine Linux for Sphinx based reStructuredText [rst] written documentation.
mr.docs is written for writing and testing documentation for Plone. It may or may not fit your use case.
The main purpose of mr.docs is testing, this is what mr.docs is written for. However you also can use mr.docs to build your documentation for production.
Features¶
- One installation
- One configuration
- Speed
- Works with different Operating Systems
- Not messing with system python and other dependencies
- ‘Smallish’
- reStructuredText lint
- Sphinx lint
- HTML test-builds
- HTML deployment builds
- Spell-check
Dependencies¶
- Docker
- Bash
If you do not have Docker installed yet, please follow the official install guide.
Getting mr.docs¶
docker pull quay.io/tiramisu/mr.docs
Updating¶
docker pull quay.io/tiramisu/mr.docs
Assumptions¶
mr.docs assumes that the documentation you want to test is located in a directory called docs
and that the documentation is written is .rst
.