Login | Register For Free | Help
Search for: (Advanced)

Mailing List Archive: Python: Dev

python sphinx install?

 

 

Python dev RSS feed   Index | Next | Previous | View Threaded


ndbecker2 at gmail

Sep 5, 2007, 5:57 AM

Post #1 of 4 (295 views)
Permalink
python sphinx install?

I'm interested in trying out new style (python 2.6) documentation. I see
we're using docutils + sphinx?

I did: svn co http://svn.python.org/projects/doctools/trunk/

How can I install this to try it with python-2.5?

_______________________________________________
Python-Dev mailing list
Python-Dev [at] python
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: http://mail.python.org/mailman/options/python-dev/list-python-dev%40lists.gossamer-threads.com


g.brandl at gmx

Sep 5, 2007, 6:05 AM

Post #2 of 4 (289 views)
Permalink
Re: python sphinx install? [In reply to]

Neal Becker schrieb:
> I'm interested in trying out new style (python 2.6) documentation. I see
> we're using docutils + sphinx?
>
> I did: svn co http://svn.python.org/projects/doctools/trunk/
>
> How can I install this to try it with python-2.5?

What do you want to try with Python 2.5?

If you want to build the Python 2.6/3.0 docs, it's easiest to check the
Python sources out from http://svn.python.org/projects/python/trunk, go to
the Doc directory and do "make html". This will checkout sphinx and all
other needed libraries into Doc/tools and build the docs.

Georg

--
Thus spake the Lord: Thou shalt indent with four spaces. No more, no less.
Four shall be the number of spaces thou shalt indent, and the number of thy
indenting shall be four. Eight shalt thou not indent, nor either indent thou
two, excepting that thou then proceed to four. Tabs are right out.

_______________________________________________
Python-Dev mailing list
Python-Dev [at] python
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: http://mail.python.org/mailman/options/python-dev/list-python-dev%40lists.gossamer-threads.com


ndbecker2 at gmail

Sep 5, 2007, 6:18 AM

Post #3 of 4 (288 views)
Permalink
Re: python sphinx install? [In reply to]

Georg Brandl wrote:

> Neal Becker schrieb:
>> I'm interested in trying out new style (python 2.6) documentation. I see
>> we're using docutils + sphinx?
>>
>> I did: svn co http://svn.python.org/projects/doctools/trunk/
>>
>> How can I install this to try it with python-2.5?
>
> What do you want to try with Python 2.5?
>
> If you want to build the Python 2.6/3.0 docs, it's easiest to check the
> Python sources out from http://svn.python.org/projects/python/trunk, go to
> the Doc directory and do "make html". This will checkout sphinx and all
> other needed libraries into Doc/tools and build the docs.
>
> Georg
>

I want to document my own python code. I figured I might as well start
using the new documentation system - but I'm using python-2.5. I intend to
use epydoc. I thought maybe I could just add sphinx to my docutils, but
maybe not?

_______________________________________________
Python-Dev mailing list
Python-Dev [at] python
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: http://mail.python.org/mailman/options/python-dev/list-python-dev%40lists.gossamer-threads.com


g.brandl at gmx

Sep 5, 2007, 6:30 AM

Post #4 of 4 (287 views)
Permalink
Re: python sphinx install? [In reply to]

Neal Becker schrieb:
> Georg Brandl wrote:
>
>> Neal Becker schrieb:
>>> I'm interested in trying out new style (python 2.6) documentation. I see
>>> we're using docutils + sphinx?
>>>
>>> I did: svn co http://svn.python.org/projects/doctools/trunk/
>>>
>>> How can I install this to try it with python-2.5?
>>
>> What do you want to try with Python 2.5?
>>
>> If you want to build the Python 2.6/3.0 docs, it's easiest to check the
>> Python sources out from http://svn.python.org/projects/python/trunk, go to
>> the Doc directory and do "make html". This will checkout sphinx and all
>> other needed libraries into Doc/tools and build the docs.
>>
>> Georg
>>
>
> I want to document my own python code. I figured I might as well start
> using the new documentation system - but I'm using python-2.5. I intend to
> use epydoc. I thought maybe I could just add sphinx to my docutils, but
> maybe not?

I see. Currently, sphinx is not ready to be used by other projects, at least
not in conjunction with tools like epydoc. (You should, however, be able to
create a rst document hierarchy like Python's and use sphinx for it.)

As soon as all needs for the Python documentation are fulfilled, I'll think
about how to make the toolset available for other projects.

Georg

--
Thus spake the Lord: Thou shalt indent with four spaces. No more, no less.
Four shall be the number of spaces thou shalt indent, and the number of thy
indenting shall be four. Eight shalt thou not indent, nor either indent thou
two, excepting that thou then proceed to four. Tabs are right out.

_______________________________________________
Python-Dev mailing list
Python-Dev [at] python
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: http://mail.python.org/mailman/options/python-dev/list-python-dev%40lists.gossamer-threads.com

Python dev RSS feed   Index | Next | Previous | View Threaded
 
 


Interested in having your list archived? Contact Gossamer Threads
 
  Web Applications & Managed Hosting Powered by Gossamer Threads Inc.