mirror of https://github.com/sbt/sbt.git
Docs: add sublit role that processes inline formatting, make default codeliteral role do no additional processing.
This was necessary because too many `` uses had * or | in them.
This commit is contained in:
Mark Harrah
parent
89d15ed1f9
commit
6d981e4c5b
|
|
@ -185,44 +185,44 @@ influence SBT execution. Also see :doc:`Launcher`.
|
|||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| Property | Values | Default | Meaning |
|
||||
+==============================+===========+=====================+====================================================+
|
||||
| `sbt.log.noformat` | Boolean | false | If true, disable ANSI color codes. Useful on build |
|
||||
| `sbt.log.noformat` | Boolean | false | If true, disable ANSI color codes. Useful on build |
|
||||
| | | | servers or terminals that don't support color. |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.global.base` | Directory | ~/.sbt | The directory containing global settings and |
|
||||
| `sbt.global.base` | Directory | ~/.sbt | The directory containing global settings and |
|
||||
| | | | plugins |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.ivy.home` | Directory | ~/.ivy2 | The directory containing the local Ivy repository |
|
||||
| `sbt.ivy.home` | Directory | ~/.ivy2 | The directory containing the local Ivy repository |
|
||||
| | | | and artifact cache |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.boot.directory` | Directory | ~/.sbt/boot | Path to shared boot directory |
|
||||
| `sbt.boot.directory` | Directory | ~/.sbt/boot | Path to shared boot directory |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.main.class` | String | | |
|
||||
| `sbt.main.class` | String | | |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `xsbt.inc.debug` | Boolean | false | |
|
||||
| `xsbt.inc.debug` | Boolean | false | |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.extraClasspath` | Classpath | | A list of classpath entries (jar files or |
|
||||
| `sbt.extraClasspath` | Classpath | | A list of classpath entries (jar files or |
|
||||
| | Entries | | directories) that are added to sbt's classpath. |
|
||||
| | | | Note that the entries are deliminted by comma, |
|
||||
| | | | e.g.: `entry1, entry2,..`. See also |
|
||||
| | | | `resources` in the :doc:`Launcher` |
|
||||
| | | | e.g.: `entry1, entry2,..`. See also |
|
||||
| | | | `resources` in the :doc:`Launcher` |
|
||||
| | | | documentation. |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.version` | Version | 0.11.3 | sbt version to use, usually taken from |
|
||||
| `sbt.version` | Version | 0.11.3 | sbt version to use, usually taken from |
|
||||
| | | | project/build.properties |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.boot.properties` | File | | |
|
||||
| `sbt.boot.properties` | File | | |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.override.build.repos` | Boolean | false | If true, repositories configured in a build |
|
||||
| `sbt.override.build.repos` | Boolean | false | If true, repositories configured in a build |
|
||||
| | | | definition are ignored and the repositories |
|
||||
| | | | configured for the launcher are used instead. See |
|
||||
| | | | `sbt.repository.config` and the :doc:`Launcher` |
|
||||
| | | | `sbt.repository.config` and the :doc:`Launcher` |
|
||||
| | | | documentation. |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
| `sbt.repository.config` | File | ~/.sbt/repositories | A file containing the repositories to use for the |
|
||||
| `sbt.repository.config` | File | ~/.sbt/repositories | A file containing the repositories to use for the |
|
||||
| | | | launcher. The format is the same as a |
|
||||
| | | | `[repositories]` section for a :doc:`Launcher` |
|
||||
| | | | `[repositories]` section for a :doc:`Launcher` |
|
||||
| | | | configuration file. This setting is typically used |
|
||||
| | | | in conjuction with setting |
|
||||
| | | | `sbt.override.build.repos` to true (see previous |
|
||||
| | | | `sbt.override.build.repos` to true (see previous |
|
||||
| | | | row and the :doc:`Launcher` documentation). |
|
||||
+------------------------------+-----------+---------------------+----------------------------------------------------+
|
||||
|
|
|
|||
|
|
@ -5,13 +5,13 @@ Global Settings
|
|||
Basic global configuration file
|
||||
-------------------------------
|
||||
|
||||
Settings that should be applied to all projects can go in `|globalSbtFile|`
|
||||
(or any file in `|globalBase|` with a `.sbt` extension).
|
||||
Plugins that are defined globally in `|globalPluginsBase|` are
|
||||
Settings that should be applied to all projects can go in :sublit:`|globalSbtFile|`
|
||||
(or any file in :sublit:`|globalBase|` with a `.sbt` extension).
|
||||
Plugins that are defined globally in :sublit:`|globalPluginsBase|` are
|
||||
available to these settings. For example, to change the default
|
||||
`shellPrompt` for your projects:
|
||||
|
||||
`|globalSbtFile|`
|
||||
:sublit:`|globalSbtFile|`
|
||||
|
||||
::
|
||||
|
||||
|
|
@ -22,10 +22,10 @@ available to these settings. For example, to change the default
|
|||
Global Settings using a Global Plugin
|
||||
-------------------------------------
|
||||
|
||||
The `|globalPluginsBase|` directory is a global plugin project. This can be
|
||||
The :sublit:`|globalPluginsBase|` directory is a global plugin project. This can be
|
||||
used to provide global commands, plugins, or other code.
|
||||
|
||||
To add a plugin globally, create `|globalPluginSbtFile|` containing
|
||||
To add a plugin globally, create :sublit:`|globalPluginSbtFile|` containing
|
||||
the dependency definitions. For example:
|
||||
|
||||
::
|
||||
|
|
@ -33,7 +33,7 @@ the dependency definitions. For example:
|
|||
addSbtPlugin("org.example" % "plugin" % "1.0")
|
||||
|
||||
To change the default `shellPrompt` for every project using this
|
||||
approach, create a local plugin `|globalShellPromptScala|`:
|
||||
approach, create a local plugin :sublit:`|globalShellPromptScala|`:
|
||||
|
||||
::
|
||||
|
||||
|
|
@ -47,10 +47,10 @@ approach, create a local plugin `|globalShellPromptScala|`:
|
|||
)
|
||||
}
|
||||
|
||||
The `|globalPluginsBase|` directory is a full project that is included as
|
||||
The :sublit:`|globalPluginsBase|` directory is a full project that is included as
|
||||
an external dependency of every plugin project. In practice, settings
|
||||
and code defined here effectively work as if they were defined in a
|
||||
project's `project/` directory. This means that `|globalPluginsBase|` can
|
||||
project's `project/` directory. This means that :sublit:`|globalPluginsBase|` can
|
||||
be used to try out ideas for plugins such as shown in the `shellPrompt`
|
||||
example.
|
||||
|
||||
|
|
|
|||
|
|
@ -127,7 +127,7 @@ and :doc:`/Detailed-Topics/Paths` for the full documentation.
|
|||
and
|
||||
`FileFilter <../api/sbt/FileFilter.html>`_.
|
||||
Note that methods with these names also exist for other types, such
|
||||
as collections (like \`Seq) and
|
||||
as collections (like `Seq`) and
|
||||
`Parser <../api/sbt/complete/Parser.html>`_
|
||||
(see :doc:`/Detailed-Topics/Parsing-Input`).
|
||||
- `x` Used to construct mappings from a `File` to another `File`
|
||||
|
|
|
|||
|
|
@ -15,13 +15,18 @@ def process_node(node):
|
|||
else:
|
||||
node = nodes.inline('', '', node)
|
||||
node['classes'].append('pre')
|
||||
print ("NODE: %s" % node)
|
||||
return node
|
||||
|
||||
# This directive formats a string to be in a fixed width font.
|
||||
# Only substitions in the string are processed.
|
||||
|
||||
# The string is taken as a literal and is not processed for further inline formatting.
|
||||
def code_literal(name, rawtext, text, lineno, inliner, options={}, content=[]):
|
||||
node = nodes.Text(text, text)
|
||||
node['classes'].append('pre')
|
||||
return [node], []
|
||||
|
||||
# This directive formats a string to be in a fixed width font.
|
||||
# It processes nested inline formatting, substitutions in particular.
|
||||
def sub_literal(name, rawtext, text, lineno, inliner, options={}, content=[]):
|
||||
memo = Struct(document=inliner.document,
|
||||
reporter=inliner.reporter,
|
||||
language=inliner.language,
|
||||
|
|
@ -33,4 +38,5 @@ def code_literal(name, rawtext, text, lineno, inliner, options={}, content=[]):
|
|||
|
||||
# register the role
|
||||
def setup(app):
|
||||
app.add_role('sublit', sub_literal)
|
||||
app.add_role('codeliteral', code_literal)
|
||||
|
|
|
|||
Loading…
Reference in New Issue