[SciPy-dev] docs.scipy.org -- new site for the documentation marathon
Sun Oct 26 12:44:36 CDT 2008
On Sun, Oct 26, 2008 at 10:41 AM, Pauli Virtanen <firstname.lastname@example.org> wrote:
> I think we will in the end need both brief API reference documentation
> (docstrings etc., explanations of common semantics such as dtype
> specifications) and then more detailed usage documentation. The current
> Sphinx docs are brief because they almost exclusively contain only the
> former, and for Scipy, mostly only the docstrings are there.
> To me, it would make sense to keep all the documentation as closely
> integrated as possible -- then you can use Sphinx's cross-referencing,
> indexing, glossary, math, etc. facilities, and the documentation will be
> easy to find, searchable, and have consistent appearance.
If my opinion isn't obvious all ready ;)
Computational Infrastructure for Research Labs
10 Giannini Hall, UC Berkeley
More information about the Scipy-dev