https://github.com/trustin/sphinx-gradle-plugin
Sphinx site generation plugin for Gradle
https://github.com/trustin/sphinx-gradle-plugin
gradle gradle-plugin site site-generator sphinx
Last synced: about 2 months ago
JSON representation
Sphinx site generation plugin for Gradle
- Host: GitHub
- URL: https://github.com/trustin/sphinx-gradle-plugin
- Owner: trustin
- License: apache-2.0
- Created: 2016-09-26T02:41:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-02-11T11:54:16.000Z (over 4 years ago)
- Last Synced: 2025-04-17T19:18:12.013Z (about 2 months ago)
- Topics: gradle, gradle-plugin, site, site-generator, sphinx
- Language: Groovy
- Homepage: https://trustin.github.io/sphinx-gradle-plugin/
- Size: 3 MB
- Stars: 18
- Watchers: 4
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## sphinx-gradle-plugin
`sphinx-gradle-plugin` is a [Gradle](https://gradle.org/) plugin that uses [Sphinx](http://www.sphinx-doc.org/)
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](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
which it then compiles into a variety of documentation formats such as HTML, LaTeX (for PDF) and ePub.
reStructured Text is similar to [Markdown](http://daringfireball.net/projects/markdown/) but - at least via
Sphinx - has better support for multi-page documentation.
Please visit [the web site](http://trustin.github.io/sphinx-gradle-plugin/) for more information.