couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Alexander Shorin <kxe...@gmail.com>
Subject Re: [jira] [Created] (COUCHDB-1658) Redirect to online docs if local aren't available
Date Tue, 29 Jan 2013 21:05:29 GMT
Hi Dave,

This matters for source-based Linux distributives like Gentoo, since
they are often provides optional flags to control features that will
be used during source build. As for Gentoo, it's a `doc` use flag
which defines will the package being build with docs stuff included or
nor - this may also defines additional dependencies that should be
resolved and installed if they don't. Dirkjan, please correct me if
I'm wrong.

This looks nothing hard, just need to dig into building process and
inject an dummy html file with version lookup and redirect to
specified location in place of sphinx html files. Not sure how correct
to do it, but I'll try to hurry up.


--
,,,^..^,,,


On Wed, Jan 30, 2013 at 12:43 AM, Dave Cottlehuber <dch@jsonified.com> wrote:
> On 29 January 2013 21:19, Alexander Shorin (JIRA) <jira@apache.org> wrote:
>> Alexander Shorin created COUCHDB-1658:
>> -----------------------------------------
>>
>>              Summary: Redirect to online docs if local aren't available
>>                  Key: COUCHDB-1658
>>                  URL: https://issues.apache.org/jira/browse/COUCHDB-1658
>>              Project: CouchDB
>>           Issue Type: Improvement
>>           Components: Documentation
>>             Reporter: Alexander Shorin
>>
>>
>> Probably, it's better to redirect user to online docs (e.g. https://couchdb.readthedocs.org/en/{version}/
) instead of showing "Not found." message if CouchDB was built without local docs support.
Since {version} might not be equal to the branch name, may be take major and minor numbers
with 'x' joined by dot '.' or set it as 'latest' if 'git' substring was found in version.
>
> It's worth noting that this will not happen with the release tgz, nor
> with anything bundled with a distribution presumably as they will have
> the docs baked in. So this relates to people using git checkouts only.
>
> Anyway a patch would be great Alex if you feel like it :D
>
> A+
> Dave

Mime
View raw message