Change .. code:: to .. code-block::

Sphinx uses .. code-block:: directives to enable highlighting:
http://sphinx-doc.org/markup/code.html#directive-code-block

Use

  for i in *.rst; do
        sed -i 's/code::/code-block::/g' $i
    done

to update these strings to enable proper highlighting.

Note: A have disabled the windows "bash" one, because the highlighting
is broken anyway...
This commit is contained in:
Stefan Tatschner
2015-05-29 16:24:58 +02:00
parent 892ad9de74
commit e5242d68b4
44 changed files with 48 additions and 48 deletions
+2 -2
View File
@@ -41,7 +41,7 @@ Building (Unix)
- Install the prerequisites. - Install the prerequisites.
- Open a terminal. - Open a terminal.
.. code:: bash .. code-block:: bash
# This should output "go version go1.3" or higher. # This should output "go version go1.3" or higher.
$ go version $ go version
@@ -69,7 +69,7 @@ Building (Windows)
- Install the prerequisites. - Install the prerequisites.
- Open a ``cmd`` Window. - Open a ``cmd`` Window.
.. code:: bash ::
# This should output "go version go1.3" or higher. # This should output "go version go1.3" or higher.
> go version > go version
+1 -1
View File
@@ -29,7 +29,7 @@ happening that should be fixed - requires investigation).
Create a new, signed tag on master, with the version as comment, and Create a new, signed tag on master, with the version as comment, and
push it: push it:
.. code:: bash .. code-block:: bash
$ git tag -a -s -u release@syncthing.net -m v0.10.15 v0.10.15 $ git tag -a -s -u release@syncthing.net -m v0.10.15 v0.10.15
$ git push --tags $ git push --tags
+1 -1
View File
@@ -4,7 +4,7 @@ ConfigSaved
Emitted after the config has been saved by the user or by Syncthing Emitted after the config has been saved by the user or by Syncthing
itself. itself.
.. code:: json .. code-block:: json
{ {
"id": 50, "id": 50,
+1 -1
View File
@@ -3,7 +3,7 @@ DeviceConnected
Generated each time a connection to a device has been established. Generated each time a connection to a device has been established.
.. code:: json .. code-block:: json
{ {
"id": 2, "id": 2,
+1 -1
View File
@@ -3,7 +3,7 @@ DeviceDisconnected
Generated each time a connection to a device has been terminated. Generated each time a connection to a device has been terminated.
.. code:: json .. code-block:: json
{ {
"id": 48, "id": 48,
+1 -1
View File
@@ -3,7 +3,7 @@ DeviceDiscovered
Emitted when a new device is discovered using local discovery. Emitted when a new device is discovered using local discovery.
.. code:: json .. code-block:: json
{ {
"id": 13, "id": 13,
+1 -1
View File
@@ -4,7 +4,7 @@ DeviceRejected
Emitted when there is a connection from a device we are not configured Emitted when there is a connection from a device we are not configured
to talk to. to talk to.
.. code:: json .. code-block:: json
{ {
"id": 24, "id": 24,
+1 -1
View File
@@ -5,7 +5,7 @@ Emitted during file downloads for each folder for each file. By default
only a single file in a folder is handled at the same time, but custom only a single file in a folder is handled at the same time, but custom
configuration can cause multiple files to be shown. configuration can cause multiple files to be shown.
.. code:: json .. code-block:: json
{ {
"id": 221, "id": 221,
+1 -1
View File
@@ -6,7 +6,7 @@ contents for a folder changes. It contains the completion percentage for
a given remote device and is emitted once per currently connected remote a given remote device and is emitted once per currently connected remote
device. device.
.. code:: json .. code-block:: json
{ {
"id": 84, "id": 84,
+1 -1
View File
@@ -4,7 +4,7 @@ FolderRejected
Emitted when a device sends index information for a folder we do not Emitted when a device sends index information for a folder we do not
have, or have but do not share with the device in question. have, or have but do not share with the device in question.
.. code:: json .. code-block:: json
{ {
"id": 27, "id": 27,
+1 -1
View File
@@ -5,7 +5,7 @@ The FolderSummary event is emitted when folder contents have changed
locally. This can be used to calculate the current local completion locally. This can be used to calculate the current local completion
state. state.
.. code:: json .. code-block:: json
{ {
"id": 16, "id": 16,
+2 -2
View File
@@ -4,7 +4,7 @@ ItemFinished
Generated when Syncthing ends synchronizing a file to a newer version. A Generated when Syncthing ends synchronizing a file to a newer version. A
successful operation: successful operation:
.. code:: json .. code-block:: json
{ {
"id": 93, "id": 93,
@@ -21,7 +21,7 @@ successful operation:
An unsuccessful operation: An unsuccessful operation:
.. code:: json .. code-block:: json
{ {
"id": 44, "id": 44,
+1 -1
View File
@@ -3,7 +3,7 @@ ItemStarted
Generated when Syncthing begins synchronizing a file to a newer version. Generated when Syncthing begins synchronizing a file to a newer version.
.. code:: json .. code-block:: json
{ {
"id": 93, "id": 93,
+1 -1
View File
@@ -5,7 +5,7 @@ Generated when the local index information has changed, due to
synchronizing one or more items from the cluster or discovering local synchronizing one or more items from the cluster or discovering local
changes during a scan. changes during a scan.
.. code:: json .. code-block:: json
{ {
"id": 59, "id": 59,
+1 -1
View File
@@ -5,7 +5,7 @@ The Ping event is generated automatically every 60 seconds. This means
that even in the absence of any other activity, the event polling HTTP that even in the absence of any other activity, the event polling HTTP
request will return within a minute. request will return within a minute.
.. code:: json .. code-block:: json
{ {
"id": 46, "id": 46,
+1 -1
View File
@@ -3,7 +3,7 @@ RemoteIndexUpdated
Generated each time new index information is received from a device. Generated each time new index information is received from a device.
.. code:: json .. code-block:: json
{ {
"id": 44, "id": 44,
+1 -1
View File
@@ -4,7 +4,7 @@ Starting
Emitted exactly once, when Syncthing starts, before parsing Emitted exactly once, when Syncthing starts, before parsing
configuration etc. configuration etc.
.. code:: json .. code-block:: json
{ {
"id": 1, "id": 1,
+1 -1
View File
@@ -4,7 +4,7 @@ StartupCompleted
Emitted exactly once, when initialization is complete and Syncthing is Emitted exactly once, when initialization is complete and Syncthing is
ready to start exchanging data with other devices. ready to start exchanging data with other devices.
.. code:: json .. code-block:: json
{ {
"id": 1, "id": 1,
+1 -1
View File
@@ -7,7 +7,7 @@ the number of seconds the folder spent in state ``from``. In the example
below, the folder ``default`` was in state ``scanning`` for 0.198 below, the folder ``default`` was in state ``scanning`` for 0.198
seconds and is now in state ``idle``. seconds and is now in state ``idle``.
.. code:: json .. code-block:: json
{ {
"id": 8, "id": 8,
+1 -1
View File
@@ -12,7 +12,7 @@ tree we want to dwell down (0 based, defaults to unlimited depth)
Optional parameter ``prefix`` defines a prefix within the tree where to Optional parameter ``prefix`` defines a prefix within the tree where to
start building the structure. start building the structure.
.. code:: bash .. code-block:: bash
$ curl -s http://localhost:8384/rest/db/browse?folder=default | json_pp $ curl -s http://localhost:8384/rest/db/browse?folder=default | json_pp
{ {
+1 -1
View File
@@ -4,7 +4,7 @@ GET /rest/db/completion
Returns the completion percentage (0 to 100) for a given device and Returns the completion percentage (0 to 100) for a given device and
folder.Takes ``device`` and ``folder`` parameters. folder.Takes ``device`` and ``folder`` parameters.
.. code:: json .. code-block:: json
{ {
"completion": 0 "completion": 0
+1 -1
View File
@@ -4,7 +4,7 @@ GET /rest/db/file
Returns most data available about a given file, including version and Returns most data available about a given file, including version and
availability. availability.
.. code:: json .. code-block:: json
{ {
"availability": [ "availability": [
+1 -1
View File
@@ -7,7 +7,7 @@ provides a compiled version of all included ignore patterns in the form
of regular expressions. Excluded items in the ``patterns`` field have a of regular expressions. Excluded items in the ``patterns`` field have a
nonstandard ``(?exclude)`` marker in front of the regular expression. nonstandard ``(?exclude)`` marker in front of the regular expression.
.. code:: json .. code-block:: json
{ {
"ignore": [ "ignore": [
+1 -1
View File
@@ -4,7 +4,7 @@ GET /rest/db/need
Takes one parameter, ``folder``, and returns lists of files which are Takes one parameter, ``folder``, and returns lists of files which are
needed by this device in order for it to become in sync. needed by this device in order for it to become in sync.
.. code:: bash .. code-block:: bash
{ {
# Files currently being downloaded # Files currently being downloaded
+1 -1
View File
@@ -3,7 +3,7 @@ POST /rest/db/prio
Moves the file to the top of the download queue. Moves the file to the top of the download queue.
.. code:: bash .. code-block:: bash
curl -X POST http://127.0.0.1:8384/rest/db/prio?folder=default&file=foo/bar curl -X POST http://127.0.0.1:8384/rest/db/prio?folder=default&file=foo/bar
+1 -1
View File
@@ -16,6 +16,6 @@ question.
Returns status 200 and no content upon success, or status 500 and a Returns status 200 and no content upon success, or status 500 and a
plain text error if an error occurred during scanning. plain text error if an error occurred during scanning.
.. code:: bash .. code-block:: bash
curl -X POST http://127.0.0.1:8384/rest/db/scan?folder=default&sub=foo/bar curl -X POST http://127.0.0.1:8384/rest/db/scan?folder=default&sub=foo/bar
+1 -1
View File
@@ -5,7 +5,7 @@ Returns information about the current status of a folder.
Parameters: ``folder``, the ID of a folder. Parameters: ``folder``, the ID of a folder.
.. code:: bash .. code-block:: bash
{ {
# latest version according to cluster: # latest version according to cluster:
+1 -1
View File
@@ -4,7 +4,7 @@ GET /rest/stats/device
Returns general statistics about devices. Currently, only contains the Returns general statistics about devices. Currently, only contains the
time the device was last seen. time the device was last seen.
.. code:: bash .. code-block:: bash
$ curl -s http://localhost:8384/rest/stats/device | json $ curl -s http://localhost:8384/rest/stats/device | json
{ {
+1 -1
View File
@@ -4,7 +4,7 @@ GET /rest/stats/folder
Returns general statistics about folders. Currently, only contains the Returns general statistics about folders. Currently, only contains the
last synced file. last synced file.
.. code:: bash .. code-block:: bash
$ curl -s http://localhost:8384/rest/stats/folder | json $ curl -s http://localhost:8384/rest/stats/folder | json
{ {
+1 -1
View File
@@ -6,7 +6,7 @@ Verifies and formats a device ID. Accepts all currently valid formats
with trivial substitutions). Takes one parameter, ``id``, and returns with trivial substitutions). Takes one parameter, ``id``, and returns
either a valid device ID in modern format, or an error. either a valid device ID in modern format, or an error.
.. code:: bash .. code-block:: bash
$ curl -s http://localhost:8384/rest/svc/deviceid?id=1234 | json $ curl -s http://localhost:8384/rest/svc/deviceid?id=1234 | json
{ {
+1 -1
View File
@@ -4,6 +4,6 @@ GET /rest/svc/lang
Returns a list of canonicalized localization codes, as picked up from Returns a list of canonicalized localization codes, as picked up from
the ``Accept-Language`` header sent by the browser. the ``Accept-Language`` header sent by the browser.
.. code:: json .. code-block:: json
["sv_sv","sv","en_us","en"] ["sv_sv","sv","en_us","en"]
+1 -1
View File
@@ -3,7 +3,7 @@ GET /rest/svc/report
Returns the data sent in the anonymous usage report. Returns the data sent in the anonymous usage report.
.. code:: json .. code-block:: json
{ {
"folderMaxFiles": 42106, "folderMaxFiles": 42106,
+1 -1
View File
@@ -3,7 +3,7 @@ GET /rest/system/config
Returns the current configuration. Returns the current configuration.
.. code:: bash .. code-block:: bash
{ {
# etc # etc
+1 -1
View File
@@ -4,7 +4,7 @@ GET /rest/system/config/insync
Returns whether the config is in sync, i.e. whether the running Returns whether the config is in sync, i.e. whether the running
configuration is the same as that on disk. configuration is the same as that on disk.
.. code:: json .. code-block:: json
{ {
"configInSync": true "configInSync": true
+1 -1
View File
@@ -4,7 +4,7 @@ GET /rest/system/connections
Returns the list of current connections and some metadata associated Returns the list of current connections and some metadata associated
with the connection/peer. with the connection/peer.
.. code:: json .. code-block:: json
{ {
"connections": { "connections": {
+1 -1
View File
@@ -3,7 +3,7 @@ GET /rest/system/discovery
Returns the contents of the local discovery cache. Returns the contents of the local discovery cache.
.. code:: json .. code-block:: json
{ {
"LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q": [ "LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q": [
+1 -1
View File
@@ -4,7 +4,7 @@ POST /rest/system/discovery/hint
Post with the query parameters ``device`` and ``addr`` to add entries to Post with the query parameters ``device`` and ``addr`` to add entries to
the discovery cache. the discovery cache.
.. code:: bash .. code-block:: bash
curl -X POST http://127.0.0.1:8384/rest/system/discovery/hint?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\&addr=192.162.129.11:22000 curl -X POST http://127.0.0.1:8384/rest/system/discovery/hint?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\&addr=192.162.129.11:22000
# Or with the X-API-Key header: # Or with the X-API-Key header:
+1 -1
View File
@@ -3,7 +3,7 @@ GET /rest/system/error
Returns the list of recent errors. Returns the list of recent errors.
.. code:: json .. code-block:: json
{ {
"errors": [ "errors": [
+1 -1
View File
@@ -3,7 +3,7 @@ GET /rest/system/ping
Returns a ``{"ping": "pong"}`` object. Returns a ``{"ping": "pong"}`` object.
.. code:: json .. code-block:: json
{ {
"ping": "pong" "ping": "pong"
+1 -1
View File
@@ -3,7 +3,7 @@ GET /rest/system/status
Returns information about current system status and resource usage. Returns information about current system status and resource usage.
.. code:: json .. code-block:: json
{ {
"alloc": 30618136, "alloc": 30618136,
+1 -1
View File
@@ -4,7 +4,7 @@ GET /rest/system/upgrade
Checks for a possible upgrade and returns an object describing the Checks for a possible upgrade and returns an object describing the
newest version and upgrade possibility. newest version and upgrade possibility.
.. code:: json .. code-block:: json
{ {
"latest": "v0.10.27", "latest": "v0.10.27",
+1 -1
View File
@@ -3,7 +3,7 @@ GET /rest/system/version
Returns the current Syncthing version information. Returns the current Syncthing version information.
.. code:: json .. code-block:: json
{ {
"arch": "amd64", "arch": "amd64",
+1 -1
View File
@@ -31,7 +31,7 @@ Config File Format
The following is an example default configuration file: The following is an example default configuration file:
.. code:: xml .. code-block:: xml
<configuration version="2"> <configuration version="2">
<folder id="default" directory="/Users/jb/Sync" ro="false" ignorePerms="false"> <folder id="default" directory="/Users/jb/Sync" ro="false" ignorePerms="false">
+3 -3
View File
@@ -193,14 +193,14 @@ the GUI from the same machine. Change the ``GUI listen address`` through
the web UI from ``127.0.0.1:8384`` to ``0.0.0.0:8384`` or change the the web UI from ``127.0.0.1:8384`` to ``0.0.0.0:8384`` or change the
config.xml: config.xml:
.. code:: xml .. code-block:: xml
<gui enabled="true" tls="false"> <gui enabled="true" tls="false">
<address>127.0.0.1:8384</address> <address>127.0.0.1:8384</address>
to to
.. code:: xml .. code-block:: xml
<gui enabled="true" tls="false"> <gui enabled="true" tls="false">
<address>0.0.0.0:8384</address> <address>0.0.0.0:8384</address>
@@ -212,7 +212,7 @@ If both your computers are Unixy (Linux, Mac, etc) You can also leave
the GUI settings at default and use an ssh port forward to access it. the GUI settings at default and use an ssh port forward to access it.
For example, For example,
.. code:: bash .. code-block:: bash
$ ssh -L 9090:127.0.0.1:8384 user@othercomputer.example.com $ ssh -L 9090:127.0.0.1:8384 user@othercomputer.example.com