couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [1/5] documentation commit: updated refs/heads/master to 59edec5
Date Sat, 30 Jul 2016 00:33:40 GMT
Repository: couchdb-documentation
Updated Branches:
  refs/heads/master eab768d17 -> 59edec503


COUCHDB-3068 Doc fixes required for Sphinx 1.4

* remove JSON as default highlight language from config
* use valid HTTP
* minor changes with shell code-blocks


Project: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/commit/ddc221f6
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/tree/ddc221f6
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/diff/ddc221f6

Branch: refs/heads/master
Commit: ddc221f65894759ea457e12876cc6467b81532a8
Parents: eab768d
Author: katsel <katsel@users.noreply.github.com>
Authored: Fri Jul 22 19:20:38 2016 +0200
Committer: katsel <katsel@users.noreply.github.com>
Committed: Fri Jul 29 14:22:44 2016 +0200

----------------------------------------------------------------------
 src/api/basics.rst            |  2 ++
 src/api/database/changes.rst  |  2 +-
 src/api/database/index.rst    |  4 ++--
 src/api/ddoc/render.rst       |  4 ++--
 src/api/ddoc/views.rst        |  2 +-
 src/api/document/common.rst   |  6 +++---
 src/api/server/common.rst     | 18 +++++++++---------
 src/conf.py                   |  2 --
 src/config/compaction.rst     | 14 ++++++++++----
 src/config/couchdb.rst        |  5 ++++-
 src/config/externals.rst      | 32 ++++++++++++++++++++++++--------
 src/config/http.rst           |  4 ++--
 src/config/intro.rst          |  7 ++++++-
 src/replication/conflicts.rst |  2 +-
 14 files changed, 67 insertions(+), 37 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/api/basics.rst
----------------------------------------------------------------------
diff --git a/src/api/basics.rst b/src/api/basics.rst
index a7def38..87fd083 100644
--- a/src/api/basics.rst
+++ b/src/api/basics.rst
@@ -143,6 +143,7 @@ Request Headers
 
   .. code-block:: http
 
+      HTTP/1.1 200 OK
       Server: CouchDB (Erlang/OTP)
       Date: Thu, 13 Jan 2011 13:39:34 GMT
       Content-Type: text/plain;charset=utf-8
@@ -165,6 +166,7 @@ Request Headers
 
   .. code-block:: http
 
+      HTTP/1.1 200 OK
       Server: CouchDB (Erlang/OTP)
       Date: Thu, 13 Jan 2013 13:40:11 GMT
       Content-Type: application/json

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/api/database/changes.rst
----------------------------------------------------------------------
diff --git a/src/api/database/changes.rst b/src/api/database/changes.rst
index c4981f4..d9f402f 100644
--- a/src/api/database/changes.rst
+++ b/src/api/database/changes.rst
@@ -434,7 +434,7 @@ to the ``filter`` parameter, specifying the design document name and
 
 .. code-block:: http
 
-    GET /db/_changes?filter=design_doc/filtername
+    GET /db/_changes?filter=design_doc/filtername HTTP/1.1
 
 Additionally, there are couple of builtin filters are available and described
 below.

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/api/database/index.rst
----------------------------------------------------------------------
diff --git a/src/api/database/index.rst b/src/api/database/index.rst
index 91d392e..386280e 100644
--- a/src/api/database/index.rst
+++ b/src/api/database/index.rst
@@ -24,13 +24,13 @@ should be the database name that you wish to perform the operation on.
 For example, to obtain the meta information for the database
 ``recipes``, you would use the HTTP request:
 
-.. code-block:: http
+.. code-block:: none
 
     GET /recipes
 
 For clarity, the form below is used in the URL paths:
 
-.. code-block:: http
+.. code-block:: none
 
     GET /db
 

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/api/ddoc/render.rst
----------------------------------------------------------------------
diff --git a/src/api/ddoc/render.rst b/src/api/ddoc/render.rst
index 51fe333..a0d7533 100644
--- a/src/api/ddoc/render.rst
+++ b/src/api/ddoc/render.rst
@@ -312,7 +312,7 @@
         Content-Type: application/json
         Host: localhost:5984
 
-        something
+        "something"
 
     **Response**:
 
@@ -377,7 +377,7 @@
         Content-Type: application/json
         Host: localhost:5984
 
-        love
+        "love"
 
     **Response**:
 

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/api/ddoc/views.rst
----------------------------------------------------------------------
diff --git a/src/api/ddoc/views.rst b/src/api/ddoc/views.rst
index 5cda00c..6daaeac 100644
--- a/src/api/ddoc/views.rst
+++ b/src/api/ddoc/views.rst
@@ -581,7 +581,7 @@ The sorting direction is applied before the filtering applied using the
 
 .. code-block:: http
 
-    GET http://couchdb:5984/recipes/_design/recipes/_view/by_ingredient?startkey=%22carrots%22&endkey=%22egg%22
+    GET http://couchdb:5984/recipes/_design/recipes/_view/by_ingredient?startkey=%22carrots%22&endkey=%22egg%22
HTTP/1.1
     Accept: application/json
 
 will operate correctly when listing all the matching entries between

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/api/document/common.rst
----------------------------------------------------------------------
diff --git a/src/api/document/common.rst b/src/api/document/common.rst
index 021c557..035d10c 100644
--- a/src/api/document/common.rst
+++ b/src/api/document/common.rst
@@ -359,7 +359,7 @@
 
     **Request**:
 
-    .. code-block:: http
+    .. code-block:: none
 
         COPY /recipes/SpaghettiWithMeatballs HTTP/1.1
         Accept: application/json
@@ -1131,7 +1131,7 @@ or :header:`If-Match`:
 
 **Request**:
 
-.. code-block:: http
+.. code-block:: none
 
     COPY /recipes/SpaghettiWithMeatballs HTTP/1.1
     Accept: application/json
@@ -1167,7 +1167,7 @@ for the target document by appending the ``rev`` parameter to the
 
 **Request**:
 
-.. code-block:: http
+.. code-block:: none
 
     COPY /recipes/SpaghettiWithMeatballs?rev=8-6f5ad8db0f34af24a6e0984cd1a6cfb9 HTTP/1.1
     Accept: application/json

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/api/server/common.rst
----------------------------------------------------------------------
diff --git a/src/api/server/common.rst b/src/api/server/common.rst
index 20b5f5d..ac58401 100644
--- a/src/api/server/common.rst
+++ b/src/api/server/common.rst
@@ -367,7 +367,7 @@ counted back from the end. For example, if you use the following request:
 
 .. code-block:: http
 
-    GET /_log?bytes=500&offset=2000
+    GET /_log?bytes=500&offset=2000 HTTP/1.1
 
 Reading of the log will start at 2000 bytes from the end of the log, and 500
 bytes will be shown.
@@ -551,7 +551,7 @@ following request:
 
 .. code-block:: http
 
-    POST http://couchdb:5984/_replicate
+    POST http://couchdb:5984/_replicate HTTP/1.1
     Content-Type: application/json
     Accept: application/json
 
@@ -576,7 +576,7 @@ by adding the ``create_target`` field to the request object:
 
 .. code-block:: http
 
-    POST http://couchdb:5984/_replicate
+    POST http://couchdb:5984/_replicate HTTP/1.1
     Content-Type: application/json
     Accept: application/json
 
@@ -600,7 +600,7 @@ synchronization between two databases by supplying the ``source`` and
 
 .. code-block:: http
 
-    POST http://couchdb:5984/_replicate
+    POST http://couchdb:5984/_replicate HTTP/1.1
     Accept: application/json
     Content-Type: application/json
 
@@ -651,7 +651,7 @@ replication ceases.
 
 .. code-block:: http
 
-    POST http://couchdb:5984/_replicate
+    POST http://couchdb:5984/_replicate HTTP/1.1
     Accept: application/json
     Content-Type: application/json
 
@@ -682,7 +682,7 @@ For example, the replication request:
 
 .. code-block:: http
 
-    POST http://couchdb:5984/_replicate
+    POST http://couchdb:5984/_replicate HTTP/1.1
     Content-Type: application/json
     Accept: application/json
 
@@ -697,7 +697,7 @@ Must be canceled using the request:
 
 .. code-block:: http
 
-    POST http://couchdb:5984/_replicate
+    POST http://couchdb:5984/_replicate HTTP/1.1
     Accept: application/json
     Content-Type: application/json
 
@@ -921,7 +921,7 @@ and statistic ID as part of the URL path. For example, to get the
 
 .. code-block:: http
 
-    GET /_stats/couchdb/request_time
+    GET /_stats/couchdb/request_time HTTP/1.1
 
 This returns an entire statistics object, as with the full request, but
 containing only the request individual statistic. Hence, the returned structure
@@ -1033,7 +1033,7 @@ could be changed to ``random`` by sending this HTTP request:
 
 .. code-block:: http
 
-    PUT http://couchdb:5984/_config/uuids/algorithm
+    PUT http://couchdb:5984/_config/uuids/algorithm HTTP/1.1
     Content-Type: application/json
     Accept: */*
 

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/conf.py
----------------------------------------------------------------------
diff --git a/src/conf.py b/src/conf.py
index 7df7669..35a0e73 100644
--- a/src/conf.py
+++ b/src/conf.py
@@ -36,8 +36,6 @@ copyright = '%d, %s' % (
     'Apache Software Foundation'
 )
 
-highlight_language = "json"
-
 primary_domain = "http"
 
 pygments_style = "sphinx"

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/config/compaction.rst
----------------------------------------------------------------------
diff --git a/src/config/compaction.rst b/src/config/compaction.rst
index 2a8c018..5db7134 100644
--- a/src/config/compaction.rst
+++ b/src/config/compaction.rst
@@ -63,9 +63,11 @@ Compaction Daemon Rules
     - ``db_fragmentation``: If the ratio of legacy data, including metadata, to
       current data in the database file size is equal to or greater than this
       value, this condition is satisfied. The percentage is expressed as an
-      integer percentage. This value is computed as::
+      integer percentage. This value is computed as:
 
-        (file_size - data_size) / file_size * 100
+      .. code-block:: none
+
+          (file_size - data_size) / file_size * 100
 
       The data_size and file_size values can be obtained when
       querying :http:get:`/{db}`.
@@ -74,7 +76,9 @@ Compaction Daemon Rules
       to current data in a view index file size is equal to or greater then
       this value, this database compaction condition is satisfied. The
       percentage is expressed as an integer percentage. This value is computed
-      as::
+      as:
+
+      .. code-block:: none
 
           (file_size - data_size) / file_size * 100
 
@@ -83,7 +87,9 @@ Compaction Daemon Rules
 
     - ``from`` and ``to``: The period for which a database (and its view group)
       compaction is allowed. The value for these parameters must obey the
-      format::
+      format:
+
+      .. code-block:: none
 
           HH:MM - HH:MM  (HH in [0..23], MM in [0..59])
 

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/config/couchdb.rst
----------------------------------------------------------------------
diff --git a/src/config/couchdb.rst b/src/config/couchdb.rst
index b4bd5c5..cceacad 100644
--- a/src/config/couchdb.rst
+++ b/src/config/couchdb.rst
@@ -182,7 +182,10 @@ Base CouchDB Options
         It is expected that the administrator has configured a load balancer
         in front of the CouchDB nodes in the cluster. This load balancer should
         use the /_up endpoint to determine whether or not to send HTTP requests
-        to any particular node. For HAProxy, the following config is appropriate ::
+        to any particular node. For HAProxy, the following config is
+        appropriate:
+
+        .. code-block:: none
 
           http-check disable-on-404
           option httpchk GET /_up

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/config/externals.rst
----------------------------------------------------------------------
diff --git a/src/config/externals.rst b/src/config/externals.rst
index 9ce0f2f..32f5bf3 100644
--- a/src/config/externals.rst
+++ b/src/config/externals.rst
@@ -43,19 +43,27 @@ OS Daemons
 
     This will make CouchDB bring up the command and attempt to keep it alive.
     To request a configuration parameter, an `os_daemon` can write a simple
-    JSON message to stdout like such::
+    JSON message to stdout like such:
+
+    .. code-block:: none
 
         ["get", "os_daemons"]\n
 
-    which would return::
+    which would return:
+
+    .. code-block:: none
 
         {"daemon_name": "/path/to/command -with args"}\n
 
-    Or::
+    Or:
+
+    .. code-block:: none
 
         ["get", "os_daemons", "daemon_name"]\n
 
-    which would return::
+    which would return:
+
+    .. code-block:: none
 
         "/path/to/command -with args"\n
 
@@ -63,26 +71,34 @@ OS Daemons
     also no method for altering the configuration.
 
     If you would like your OS daemon to be restarted in the event that the
-    configuration changes, you can send the following messages::
+    configuration changes, you can send the following messages:
+
+    .. code-block:: none
 
         ["register", $(SECTION)]\n
 
     When anything in that section changes, your OS process will be rebooted so
     it can pick up the new configuration settings. If you want to listen for
-    changes on a specific key, you can send something like::
+    changes on a specific key, you can send something like:
+
+    .. code-block:: none
 
         ["register", $(SECTION), $(KEY)]\n
 
     In this case, CouchDB will only restart your daemon if that exact
     section/key pair changes, instead of anything in that entire section.
 
-    Logging commands look like::
+    Logging commands look like:
+
+    .. code-block:: none
 
         ["log", $(JSON_MESSAGE)]\n
 
     Where ``$(JSON_MESSAGE)`` is arbitrary JSON data. These messages are logged
     at the 'info' level. If you want to log at a different level you can pass
-    messages like such::
+    messages like such:
+
+    .. code-block:: none
 
         ["log", $(JSON_MESSAGE), {"level": $(LEVEL)}]\n
 

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/config/http.rst
----------------------------------------------------------------------
diff --git a/src/config/http.rst b/src/config/http.rst
index d342b76..b79eb7e 100644
--- a/src/config/http.rst
+++ b/src/config/http.rst
@@ -274,7 +274,7 @@ Secure Socket Level Options
     Now start (or restart) CouchDB. You should be able to connect to it
     using HTTPS on port 6984:
 
-    .. code-block:: bash
+    .. code-block:: console
 
         shell> curl https://127.0.0.1:6984/
         curl: (60) SSL certificate problem, verify that the CA cert is OK. Details:
@@ -297,7 +297,7 @@ Secure Socket Level Options
     notifies you. Luckily you trust yourself (don't you?) and you can specify
     the ``-k`` option as the message reads:
 
-    .. code-block:: bash
+    .. code-block:: console
 
         shell> curl -k https://127.0.0.1:6984/
         {"couchdb":"Welcome","version":"1.5.0"}

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/config/intro.rst
----------------------------------------------------------------------
diff --git a/src/config/intro.rst b/src/config/intro.rst
index b837644..a6c1c5c 100644
--- a/src/config/intro.rst
+++ b/src/config/intro.rst
@@ -11,7 +11,6 @@
 .. the License.
 
 .. default-domain:: config
-.. highlight:: ini
 .. _config/intro:
 
 =============================
@@ -43,6 +42,8 @@ target operation system and may be changed during building from the source
 code. For binary distributions, it mostly points to the installation path
 (e.g. ``C:\Program Files\CouchDB\etc\couchdb`` for Windows).
 
+.. highlight:: shell
+
 To see the actual configuration files chain run in shell::
 
     couchdb -c
@@ -104,6 +105,8 @@ The common way to set some parameters is to edit the `local.ini` file
which is
 mostly located in the `etc/couchdb` directory relative your installation path
 root.
 
+.. highlight:: ini
+
 For example::
 
     ; This is a comment
@@ -143,6 +146,8 @@ to apply these changes.
 Setting parameters via the HTTP API
 ===================================
 
+.. highlight:: shell
+
 Alternatively, configuration parameters could be set via the
 :ref:`HTTP API <api/config>`. This API allows to change CouchDB configuration
 on-the-fly without requiring a server restart::

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/ddc221f6/src/replication/conflicts.rst
----------------------------------------------------------------------
diff --git a/src/replication/conflicts.rst b/src/replication/conflicts.rst
index 27904c6..ef33a89 100644
--- a/src/replication/conflicts.rst
+++ b/src/replication/conflicts.rst
@@ -176,7 +176,7 @@ database, which is what you'd have to do in a multi-master application
anyway.
 
 .. code-block:: http
 
-    POST /db/_bulk_docs
+    POST /db/_bulk_docs HTTP/1.1
 
 .. code-block:: javascript
 


Mime
View raw message