← Back to team overview

launchpad-dev team mailing list archive

Re: New developer documentation [experimental]

 

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 2/16/2011 8:23 AM, Benji York wrote:
> On Wed, Feb 16, 2011 at 9:08 AM, Jonathan Lange <jml@xxxxxxxxxxxxx> wrote:
>> On Wed, Feb 16, 2011 at 2:06 PM, Benji York <benji.york@xxxxxxxxxxxxx> wrote:
>>> On Wed, Feb 16, 2011 at 8:31 AM, Jonathan Lange <jml@xxxxxxxxxxxxx> wrote:
>>>> We now have a browseable version of Launchpad's developer
>>>> documentation at <http://lpqateam.canonical.com/doc/>.
>>>
>>> Quite nice.
>>>
>>>> It's very early days now, but the plan is:
>>> [...]
>>>>  * add some checks to prevent new rST / sphinx errors
>>>
>>> +1
>>>
>>> I did something similar in having a test that would build the Sphinx and
>>> cause a test failure if any warnings or errors were encountered.  It
>>> really helped prevent doc breakage.
>>
>> That was my plan. Can I pinch that test, or should I roll my own?
> 
> Sorry, it was a closed-source project.  Wheel-reinvention required.

Note that in bzr, we just put "make doc" as part of the "make check" target:

check: docs
  bzr selftest ...

So that the Make itself will fail. Not quite as slick as having a test
case fail, but accomplished the same goal.

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk1b88EACgkQJdeBCYSNAAN87QCgspTBbKjiKZZM5ywZYNa3dIar
Or0AoNXa5T7RdmezL714Kb5tQ368xF8h
=86/f
-----END PGP SIGNATURE-----



References