You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by wo...@apache.org on 2019/02/01 18:55:58 UTC

[couchdb-documentation] branch master updated: Config cluster ref fix (#384)

This is an automated email from the ASF dual-hosted git repository.

wohali pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git


The following commit(s) were added to refs/heads/master by this push:
     new aea530b  Config cluster ref fix (#384)
aea530b is described below

commit aea530b5b90fa943436e229f34f1e4ccc1b6adde
Author: Jay Doane <ja...@gmail.com>
AuthorDate: Fri Feb 1 10:55:53 2019 -0800

    Config cluster ref fix (#384)
    
    * Document virtualenv use in README
    * Fix broken reference in cluster config docs
    Fixes #383
---
 .gitignore             | 1 +
 README.md              | 4 +++-
 src/config/cluster.rst | 2 +-
 3 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 5a459b8..aeffe01 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,7 @@
 ext/*.pyc
 ext/__pycache__/
 build/
+venv
 *~
 *.swp
 *.bak
diff --git a/README.md b/README.md
index b8e2738..93b0181 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,9 @@ You can view the latest rendered build of this content at:
 Install Python 2.7+ and pip. Then:
 
 ```sh
-$ sudo pip install Sphinx sphinx_rtd_theme
+$ virtualenv venv
+$ . ./venv/bin/activate
+$ pip install -r requirements.txt
 $ make html # builds the docs
 $ make check # syntax checks the docs
 ```
diff --git a/src/config/cluster.rst b/src/config/cluster.rst
index a7d605f..ca229e5 100644
--- a/src/config/cluster.rst
+++ b/src/config/cluster.rst
@@ -40,7 +40,7 @@ Cluster Options
     creation time.
 
     .. seealso::
-        httpdomain:put:`PUT /{db} </{db}>`
+        :http:put:`PUT /{db} </{db}>`
 
     .. config:option:: n