[SciPy-Dev] Understanding source of docs, source file ".py" or ".rst" file

Vincent Davis vincent@vincentdavis....
Tue Jun 29 08:36:43 CDT 2010


On Tue, Jun 29, 2010 at 2:55 AM, Pauli Virtanen <pav@iki.fi> wrote:
> Mon, 28 Jun 2010 23:04:39 -0500, Skipper Seabold wrote:
> [clip]
>> I also struggled to understand this at first.  Is this documented
>> somewhere?  If not, where would be best?  I'm thinking somewhere on the
>> main docs page.  I don't know that the Question and Answers page is
>> obvious enough.  Would the "before you start" be a good place?
>
> If you think about how Sphinx works, all this becomes clear. But perhaps
> it should be explicitly explained somewhere.
>
I guess my specific question is? When editing docs on the wiki should
I edit, for example
"scipy-docs/constants.rst"
http://docs.scipy.org/scipy/docs/scipy-docs/constants.rst/#scipy-docs-constants-rst
or
http://docs.scipy.org/scipy/docs/scipy.constants.constants/
or both
or is it like Skipper said
"I believe that you edit the .rst files via the docs wiki and that they
are applied to the actual source modules by hand intermittently (ie.,
before a release, when a lot of progress has been made, or after a
docs marathon or sprint)."

Thanks
Vincent


> --
> Pauli Virtanen
>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev@scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>


More information about the SciPy-Dev mailing list