Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
MIME-Version: 1.0
In-Reply-To: 
 <CAEkz3NyUdZYTHGmWSu7mRQ5UhcgHSzR4cMjq=LvPE++f21KvKg@mail.gmail.com>
References: 
 <CAEkz3Nw4=sMw=5meXKv545iJ67ACnVcHiKxDSkEbaGBx1ggWCw@mail.gmail.com>
	<CAL+Y1nuZXeO2sYRRQNKXnvmPzHWFXavpXxL_tbWDw-K0uQwEhw@mail.gmail.com>
	<CAKmKYaC5YFo8Q6t2yK5M-GX_K0Uh-CkA-_+=e1QG0jM5-h9nMw@mail.gmail.com>
	<CAEkz3Nx-VkZUgro=91-6u8ZUd3qN2C18-jxw7d1N=Z_9GoEr2A@mail.gmail.com>
	<CAKmKYaA7X7w-n4jyy+TStzND6z+tMjAJGrxg6+DL2tK8nQaCQA@mail.gmail.com>
	<CAL+Y1nsHkGePbr23b0UBXz=r_UTdm0qRVUao_r1btaW6LBN6Yw@mail.gmail.com>
	<CAPaJBx57V9K3hXyNmAuhoFmruV204pdmvaF=t-a6QH4gXe-ASQ@mail.gmail.com>
	<CAEkz3NxWYgqJn-D_fzur6QGNw3ZxMYbYRRoZ8MN4My+EkS1N+Q@mail.gmail.com>
	<CAPaJBx7T6H0PwrvLE-3qXV_b=SMRcHuiD8EZ_by2hHUf8cZa2w@mail.gmail.com>
	<CAEkz3NyUdZYTHGmWSu7mRQ5UhcgHSzR4cMjq=LvPE++f21KvKg@mail.gmail.com>
Date: Fri, 2 Aug 2013 21:18:50 +0100
Message-ID: 
 <CAPaJBx6u6AgNyXRxQN3E_N_XdiqonO3ow7BfnuyZRYhfF8eeRQ@mail.gmail.com>
Subject: Re: Project proposal for ICFOSS
From: Noah Slater <nslater@apache.org>
To: Yashin Mehaboobe <yashinm92@gmail.com>
Cc: "dev@couchdb.apache.org" <dev@couchdb.apache.org>,
 Noah Slater <nslater@apache.org>,
	Dirkjan Ochtman <djc.ochtman@gmail.com>, Dave Cottlehuber <dch@jsonified.com>
Content-Type: multipart/alternative; boundary=f46d04374a09b8b24804e2fcaa8c

--f46d04374a09b8b24804e2fcaa8c
Content-Type: text/plain; charset=ISO-8859-1

On 30 July 2013 20:13, Yashin Mehaboobe <yashinm92@gmail.com> wrote:

>
> 1.User runs bootstrap
>

Yep. But remember: only people building CouchDB from a Git checkout will
ever need to run ./boostrap. When we distribute CouchDB from our website,
all of the files that ./boostrap generates are included for them.


> 2.Bootstrap fetches the git commit messages too and stores in an rst file
>

Sounds good.


> 3.The python script uses this rst file to generate documentation.
>

Yep! But note: the Python script that generates the RST files is called by
make. So we have two steps here:

./bootstrap run on a pristine source checkout, and only run by devs. It
talks to Git, and generates an RST file.

Make is configured to expect the RST file, as if it were a regular part of
the source. When you run "make", the regular rules for building the docs
should pick up the RST file and include it into the docs.

-- 
NS

--f46d04374a09b8b24804e2fcaa8c--