couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From woh...@apache.org
Subject [couchdb-documentation] branch master updated: Update how-to-build info
Date Tue, 01 Aug 2017 03:31:51 GMT
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 adc6038  Update how-to-build info
adc6038 is described below

commit adc6038612ac663764ff4ff35344afeeaad85484
Author: Joan Touzet <joant@atypical.net>
AuthorDate: Mon Jul 31 23:31:38 2017 -0400

    Update how-to-build info
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 60adad6..b8e2738 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,15 @@ You can view the latest rendered build of this content at:
 
     http://docs.couchdb.org/en/latest
 
+# Building this repo
+
+Install Python 2.7+ and pip. Then:
+
+```sh
+$ sudo pip install Sphinx sphinx_rtd_theme
+$ make html # builds the docs
+$ make check # syntax checks the docs
+```
 # Feedback, Issues, Contributing
 
 General feedback is welcome at our [user][1] or [developer][2] mailing lists.
@@ -16,3 +25,4 @@ with issue reporting or contributing to the upkeep of this project.
 [2]: http://mail-archives.apache.org/mod_mbox/couchdb-dev/
 [3]: https://github.com/apache/couchdb/blob/master/CONTRIBUTING.md
 
+

-- 
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <commits@couchdb.apache.org>'].

Mime
View raw message