sphinx-gradle-plugin¶
sphinx-gradle-plugin is a Gradle plugin that uses Sphinx to generate a project web site or documentation.
Sphinx itself was originally created by the Python community for the new Python documentation. It uses a plaintext format called reStructured Text which it then compiles into a variety of documentation formats such as HTML, LaTeX (for PDF) and ePub. reStructured Text is similar to Markdown but - at least via Sphinx - has better support for multi-page documentation.
Extensions¶
This plugin provides the following additional extensions out of the box:
Themes¶
This plugin provides the following additional themes out of the box:
License¶
Changelog¶
Credits¶
This plugin reuses the SphinxRunner implementation of sphinx-maven-plugin originally written by
Thomas Dudziak. Bala Sridhar since then upgraded Sphinx to 1.3.1 and added PlantUML
support in his fork. I’d like to appreciate their effort that did all the heavy lifting.