[sphinx-dev] Re: wiring sphinx into building source distros?
On Jun 30, 9:43 am, Chris Withers ch...@simplistix.co.uk wrote: Stéfan van der Walt wrote: Would you like to generate those documents via your setup.py? You can have a look at what Enthought is doing with their setupdocs tool: http://pypi.python.org/pypi/SetupDocs/1.0.2 This doesn't look like it uses Sphinx... What does it use? Where are the docs? SetupDocs is indeed used by most all ETS projects to run Sphinx during the generation of distributions via setup.py sdist, setup.py bdist_egg, etc. Unfortunately the docs for the project aren't that great, but there are a number of examples -- the other ETS projects. For example, Mayavi. You can browse the ETS project sources (including SetupDocs) itself via our Trac gateway to SVN here: https://svn.enthought.com/enthought/browser. I would suggest starting out by looking at the setup.cfg and setup.py for the Mayavi project here: https://svn.enthought.com/enthought/browser/Mayavi/trunk Note: the aliases in the setup.cfg and the customization of various build commands in the setup.py. If anyone is curious, the docs at http://code.enthought.com/projects/mayavi/docs/development/html/mayavi/ were generated by this integration with SetupDocs. --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
[sphinx-dev] Re: wiring sphinx into building source distros?
On Jun 30, 10:46 am, Stéfan van der Walt ste...@sun.ac.za wrote:
2009/6/30 Chris Withers ch...@simplistix.co.uk:
http://pypi.python.org/pypi/SetupDocs/1.0.2
This doesn't look like it uses Sphinx...
What does it use?
It uses Sphinx (at least, I see Sphinx mentioned many times in the sources).
After installing SetupDocs, you should be able to do something like
from setuptools.command.develop import develop
class MyBuild(distbuild):
def run(self):
distbuild.run(self)
self.run_command('build_docs')
setup(
...
'build': MyBuild,
)
Last week I added a couple of setup keyword args for greater control
over where the rst files are and over where the generated docs get
put. For example:
setup(...
docs_source='doc/source',
docs_dest='doc'
...)
Assuming the package name is Foo, the generated docs will go in Foo/
doc/html and Foo/doc/pdf when installed.
I am not the original author, and I've only tested my changes with
eggs, but it should work for other distribution methods. The changes
are in svn trunk, and will be in the next ETS release scheduled for
July 15th.
Bryce
--~--~-~--~~~---~--~~
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-dev@googlegroups.com
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~--~~~~--~~--~--~---
[sphinx-dev] Re: wiring sphinx into building source distros?
Hi Chris 2009/6/30 Chris Withers ch...@simplistix.co.uk: I'd like my source distros to include generated sphinx output in html and pdf. Has anyone done this? If so, how? Would you like to generate those documents via your setup.py? You can have a look at what Enthought is doing with their setupdocs tool: http://pypi.python.org/pypi/SetupDocs/1.0.2 Regards Stéfan --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
[sphinx-dev] Re: wiring sphinx into building source distros?
Hello, I include in one my debian package a man page which is rendered from rst into the man format when building the package. It is specific to debian packaging system, the shell command is included in the 'build' phase of the debian/rules. Cheers On Tue, Jun 30, 2009 at 1:44 PM, Chris Withersch...@simplistix.co.uk wrote: Hi All, I'd like my source distros to include generated sphinx output in html and pdf. Has anyone done this? If so, how? cheers, Chris -- Rasterization Zion babylon --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
[sphinx-dev] Re: wiring sphinx into building source distros?
2009/6/30 Chris Withers ch...@simplistix.co.uk:
http://pypi.python.org/pypi/SetupDocs/1.0.2
This doesn't look like it uses Sphinx...
What does it use?
It uses Sphinx (at least, I see Sphinx mentioned many times in the sources).
After installing SetupDocs, you should be able to do something like
from setuptools.command.develop import develop
class MyBuild(distbuild):
def run(self):
distbuild.run(self)
self.run_command('build_docs')
setup(
...
'build': MyBuild,
)
Cheers
Stéfan
--~--~-~--~~~---~--~~
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-dev@googlegroups.com
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~--~~~~--~~--~--~---
[sphinx-dev] Re: wiring sphinx into building source distros?
On Jun 30, 2009, at 7:44 AM, Chris Withers wrote: Hi All, I'd like my source distros to include generated sphinx output in html and pdf. Has anyone done this? If so, how? I've had good luck layering Paver on top of both setuptools and sphinx for this purpose. Doug --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to this group, send email to sphinx-dev@googlegroups.com To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~--~~~~--~~--~--~---
[sphinx-dev] Re: wiring sphinx into building source distros?
On Tue, Jun 30, 2009 at 05:46:17PM +0200, Stéfan van der Walt wrote:
2009/6/30 Chris Withers ch...@simplistix.co.uk:
http://pypi.python.org/pypi/SetupDocs/1.0.2
This doesn't look like it uses Sphinx...
What does it use?
It uses Sphinx (at least, I see Sphinx mentioned many times in the sources).
After installing SetupDocs, you should be able to do something like
from setuptools.command.develop import develop
class MyBuild(distbuild):
def run(self):
distbuild.run(self)
self.run_command('build_docs')
setup(
...
'build': MyBuild,
)
You can see a simplified version of that idea at:
http://bazaar.launchpad.net/~nipy-developers/nipy/gael-tmp/annotate/head%3A/setup.py
The setup.cfg is important too.
This does not make use of setuptools, just distutils and sphinx.
Gaël
--~--~-~--~~~---~--~~
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To post to this group, send email to sphinx-dev@googlegroups.com
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~--~~~~--~~--~--~---
