Plone-DocsBuilder¶
Containerized application based on Sphinx for test builds of docs.plone.org.
The main purpose of this application is to create test builds in an ‘easy’, ‘fast’ and ‘repeatable’ way.
Note
plone-docsbuilder is not a full replacement of Sphinx !
plone-docsbuilder is for creating ‘test builds’ to get a visual impression not for more, no spell-check, no link-check and so on.
Limitations¶
- plone-docsbuilder depends on an index.rst file in your root documentation directory, see our Roadmap for more info
- plone-docsbuilder will report a warning, if there is no _static directory in your root documentation directory
- sphinxcontrib-osexample is not included, yet