Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
trustin committed Apr 4, 2020
1 parent 24fadf3 commit 8c1d1ff
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 20 deletions.
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
group=kr.motd.gradle
name=sphinx-gradle-plugin
version=2.7.3-SNAPSHOT
version=2.8.0-SNAPSHOT
6 changes: 3 additions & 3 deletions src/site/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@

project = u'sphinx-gradle-plugin'
copyright = u'2017, Trustin Lee et al'
version = '2.7'
release = '2.7.2'
version = '2.8'
release = '2.8.0'

# General options
needs_sphinx = '1.0'
Expand All @@ -37,7 +37,7 @@
source_suffix = ['.rst', '.md']
source_encoding = 'utf-8-sig'
source_parsers = {
'.md': CommonMarkParser
'.md': CommonMarkParser
}

# HTML options
Expand Down
34 changes: 18 additions & 16 deletions src/site/sphinx/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,24 @@ Configuration

``sphinx-gradle-plugin`` has these configuration options:

======================== ================================================================================================= ========================================
Parameter Description Default value
======================== ================================================================================================= ========================================
``sourceDirectory`` The directory containing the documentation source. ``${project.projectDir}/src/site/sphinx``
``outputDirectory`` The directory where the generated output will be placed. ``${project.buildDir}/site``
``binaryUrl`` The URL of the Sphinx executable binary. Must start with ``file:``, ``http:`` or ``https:`` <automatic>
``environments`` The environment variables to set when launching Sphinx. e.g. ``environments = ['foo':'bar']``
``dotBinary`` The path of Graphviz ``dot`` binary.
``builder`` The builder to use. See `Available builders`_ for a list of possible builders. ``html``
``verbose`` Whether Sphinx should generate verbose output. ``true``
``traceback`` Whether Sphinx should print full traceback on exception. ``true``
``warningsAsErrors`` Whether warnings should be treated as errors. ``false``
``force`` Whether Sphinx should generate output for all files instead of only the changed ones. ``false``
``tags`` Additional tags to pass to Sphinx. See `Including content based on tags`_ for more information.
``skip`` Whether Sphinx execution should be skipped. ``false``
======================== ================================================================================================= ========================================
========================= ================================================================================================= ========================================
Parameter Description Default value
========================= ================================================================================================= ========================================
``sourceDirectory`` The directory containing the documentation source. ``${project.projectDir}/src/site/sphinx``
``outputDirectory`` The directory where the generated output will be placed. ``${project.buildDir}/site``
``binaryUrl`` The URL of the Sphinx executable binary. Must start with ``file:``, ``http:`` or ``https:`` <automatic>
``environments`` The environment variables to set when launching Sphinx. e.g. ``environments = ['foo':'bar']``
``dotBinary`` The path of Graphviz ``dot`` binary.
``builder`` The builder to use. See `Available builders`_ for a list of possible builders. ``html``
``verbose`` Whether Sphinx should generate verbose output. ``true``
``traceback`` Whether Sphinx should print full traceback on exception. ``true``
``warningsAsErrors`` Whether warnings should be treated as errors. ``false``
``force`` Whether Sphinx should generate output for all files instead of only the changed ones. ``false``
``tags`` Additional tags to pass to Sphinx. See `Including content based on tags`_ for more information.
``skip`` Whether Sphinx execution should be skipped. ``false``
``useDoctreeCache`` Whether doctree cache should be used. ``false``
``doctreeCacheDirectory`` The directory containing Sphinx doctree cache. Used only when ``useDoctreeCache`` is ``true`` ``${project.buildDir}/site/.doctrees``
========================= ================================================================================================= ========================================

Sample Documentation Config
===========================
Expand Down

0 comments on commit 8c1d1ff

Please sign in to comment.