Skip to content
This repository has been archived by the owner on Jun 13, 2019. It is now read-only.

Containerized application based on Sphinx for test builds of docs.plone.org

License

Notifications You must be signed in to change notification settings

testthedocs/plone-docsbuilder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Plone-Docsbuilder

Containerized application based on Sphinx for test builds of docs.plone.org.

Note:

plone-docsbuilder is written to do one thing in a certain way, it is not written to be a full replacement of Sphinx.

If you try to use plone-docsbuilder in a way it is not intended for, it will most likely not work !

Please make sure to read the docs.

Features

  • 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.
  • Uses Tini as init.
  • Uses su-exec for setting permissions.

Documentation

Full documentation for end users can be found in the "docs" folder.

Dependencies

Installation

Pull the image:

docker pull testthedocs/plone-docsbuilder

Contribute

Support

If you are having issues, please let us know.

License

The project is licensed under the GPLv2.