Excerpts from Nick Coghlan's message of 2013-02-27 12:06:13 +1000:
On 02/27/2013 08:32 AM, Dan Callaghan wrote:
> Excerpts from Nick Coghlan's message of 2013-02-26 19:32:55 +1000:
>> In relation to this - perhaps we should build the develop branch with
>> Sphinx in warning mode?
> We could, although we then run the risk of doc errors not being noticed
> until we go to do the release. At least now we are forced to fix them up
> during development. I'm not sure which is more annoying.
I think the embedded warnings are one of the *advantages* of the
lightweight markup formats, so I'm in favour of relaxing the build
requirements at least for docs-develop.
In *addition*, though, we should make it clear to everyone that a
with docs changes shouldn't be marked verified without first running
"make html" in the documentation directory to check it doesn't generate
any warnings or errors.
> I also want to add a version number to the Sphinx titles. And I
> thinking it might be worthwhile adjusting the templates somehow, to add
> a little note at the top of every page in docs-develop/ explaining that
> it refers to an unreleased version of Beaker and is not final, etc.
Those both sound like excellent ideas.
Dan Callaghan <dcallagh(a)redhat.com>
Software Engineer, Infrastructure Engineering and Development
Red Hat, Inc.