couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Kowalski (JIRA)" <>
Subject [jira] [Commented] (COUCHDB-1787) Automate release process documentation
Date Thu, 19 Mar 2015 01:56:39 GMT


Robert Kowalski commented on COUCHDB-1787:

Hi Amarnath!

Sounds good! Are you participating in this years Google Summer of Code?

The Sphinx config that Dave mentioned is now located at

If you clone the main repository and have installed erlang
& rebar [1],  rebar will pull in the docs after running `./configure`

If I have the couchdb repo at `~/apache/couchdb/` the docs are then pulled to: `~/apache/couchdb/src/docs`

I think that are the updates related to this task as the codebase and structure evolved over


> Automate release process documentation
> --------------------------------------
>                 Key: COUCHDB-1787
>                 URL:
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Build System, Documentation
>            Reporter: Dave Cottlehuber
>              Labels: gsoc, gsoc2015, mentor
> The release process today contains a large number of manual transformation steps.
> Fixing this will make the release process significantly easier for release managers,
as well as less error-prone.
> Ideally the output formats (NEWS, CHANGES in source tree, and HTML snippets for
website and ) can be auto-generated from either the .rst files
in share/doc/src using sphinx's .versionaddded/changed tags, or potentially from commit messages
if this is appropriate.
> CouchDB documentation is generated today from restructured text using python code, and
rolled into the release documentation during `make distcheck`.

This message was sent by Atlassian JIRA

View raw message