[IPython-dev] Confusion about dev docs...take 2...

[Brian Granger]

The problem is that next time someone adds dev related docs, they
won't know where to put it. Some of them will put it into Sphinx and
we will be back to having our dev docs all over the place. This
experiment in the past has shown that this process converges to having
>=2, out of synch copies, of all our dev docs in different places.

I am fine if we want to revisit the location of our dev docs, but
until then, I think we should keep everything on Github...

If the issue is that you personally don't want to move it over to
GitHub, I don't mind doing that. But I don't want to be the only one
who *thinks* we are trying to keep things on GitHub.

Cheers,

Brian

On Tue, Oct 29, 2013 at 6:09 PM, Thomas Kluyver <takowl at gmail.com> wrote:
> I'm not sure that the distinction is that clear - all of the docs already in
> that section seem potentially useful to people working on IPython itself, as
> well as on related projects. The version compatibility stuff could also be
> useful to developers of related projects, although there's plenty of other
> such advice out there on the net.
>
> But ultimately, I just preferred to do this as a Sphinx doc than a wiki
> page.
>
> Thomas
>
>
> On 29 October 2013 17:48, Brian Granger <ellisonbg at gmail.com> wrote:
>>
>> OK, let me try this again...
>>
>> Here is what our Sphinx docs say about "Development related docs":
>>
>> ###
>> This are two categories of developer focused documentation:
>>
>> Documentation for developers of IPython itself.
>> Documentation for developers of third party tools and libraries that
>> use IPython.
>>
>> This part of our documentation only contains information in the second
>> category.
>>
>> Developers interested in working on IPython itself should consult our
>> developer information on the IPython GitHub wiki.
>> ###
>>
>> To me this suggests that anything related to writing code for IPython
>> should go in the GitHub wiki. That is what I thought we were doing.
>> OK, all of that makes sense to me.
>>
>> But then I just saw the Python 2+3 dev docs were put into the Sphinx docs:
>>
>> http://ipython.org/ipython-doc/dev/development/pycompat.html
>>
>> Shouldn't this be on Github as it only really relates to people
>> writing code for IPython?
>>
>> Cheers,
>>
>> Brian
>>
>>
>> --
>> Brian E. Granger
>> Cal Poly State University, San Luis Obispo
>> bgranger at calpoly.edu and ellisonbg at gmail.com
>> _______________________________________________
>> IPython-dev mailing list
>> IPython-dev at scipy.org
>> http://mail.scipy.org/mailman/listinfo/ipython-dev
>
>
>
> _______________________________________________
> IPython-dev mailing list
> IPython-dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/ipython-dev
>



-- 
Brian E. Granger
Cal Poly State University, San Luis Obispo
bgranger at calpoly.edu and ellisonbg at gmail.com