[IPython-dev] Fwd: IPython documentation

Fernando Perez fperez.net@gmail....
Thu Sep 11 16:55:43 CDT 2008


Hey Pauli,

I'm replying with your full message below so it goes to the list,
since I think this is both interesting and exciting for others as
well.

I don't have right now the bandwidth to test it, but I'm very happy to
see pydocweb moving in this direction.  Ultimately I think this is
moving exactly in the direction I'd like to see tools for managing
*all* docs for an open source project.  I hope after we settle down a
bit with the giant code/architecture merges we're tackling right now,
we can look into this for ipython.

Alternatively, if anyone likes this kind of work and would like to
play with getting it up and running for the ipython docs and codebase,
it would make a great contribution to the project :)

Cheers,

f

On Sun, Sep 7, 2008 at 12:13 PM, Pauli Virtanen <pav@iki.fi> wrote:
> Hi Fernando,
>
> On ti, 2008-06-17 at 17:17 -0700, Fernando Perez wrote:
> [clip: Re: Sphinx documents in the scipy doc editor web app]
>> But if you do want to contribute on any of this (which sooner or later
>> ipython, numpy, scipy, matplotlib, proably sympy, etc will want), I
>> think that a solution that integrates with the version control backend
>> naturally would be the easiest.  I don't know how you guys implemented
>> it, but I'd think that simply:
>>
>> - producing one wiki page per .rst/.txt in a given directory
>> - generating one local commit into a special branch per user-visible
>> change
>>
>> should be enough, no?  Then, the editors can merge/reject those
>> individual commits into the trunk.
>
> Part of this is now implemented:
>
> - Pydocweb can now extract Sphinx documentation pages, and generate
>  patches against them.
>
> toctree:: is handled, but most other Sphinx cross-references do not work
> properly yet. Also, the CSS probably needs some tweaking, as the
> rendered document pages look quite fugly :)
>
> If you want to check it out, here's the branch
>
>        https://code.launchpad.net/~pauli-virtanen/scipy/pydocweb
>
> There's a sample configuration for IPython in there, and steps in taking
> it into use are explained in README.txt.
>
>        Pauli
>
>
>


More information about the IPython-dev mailing list