launchpad-dev team mailing list archive

[Aaron Bentley <aaron@xxxxxxxxxxxxx>]

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

On 11-10-06 05:14 AM, Matthew Revell wrote:
> Now, as for whether we favour Sphinx docs or doctests, I'm a
> little less clear on. I prefer the Sphinx stuff because anyone can
> access them via rtfd. However, my experience with doctests is
> pretty limited.

I think we should favour doctests, but we may be able to provide them
through Sphinx.  I don't like calling them "doctests", because they
should be testable documentation, rather than being focused on
testing.  We should just call them documentation.

Sphinx has an extension for doctests, so we may be able to support
them through Sphinx.  Read The Docs doesn't indicate whether they
support that extension.

I think a lot of our existing doctests are primarily focused on
testing, so they would need some rehabilitation before we'd want to
include them in Sphinx documentation.

Aaron
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk6NryUACgkQ0F+nu1YWqI34jQCghjR8bqgfZ5uGHY6nSzIQ2yMd
wBgAn3+/iG8cI9fgdBJT3RIhAH0yYG3u
=UYa3
-----END PGP SIGNATURE-----