Re: [sphinx-dev] How do I use output a config value in my .rst files?

2012-04-22 Thread Doug Hellmann
Hi, Matt, I don't think there is a way to spit out the value of the variable in core Sphinx (though that would be useful). In your case, you probably want to build a custom role processor (http://www.doughellmann.com/articles/how-tos/sphinx-custom-roles/index.html). Then you could include

[sphinx-dev] Sphinx + PyEnchant integration

2010-12-28 Thread Doug Hellmann
I have started work on a Sphinx extension to check the spelling of documents using PyEnchant. Version 0.1 is available for beta testing from my web site (http://www.doughellmann.com/projects/sphinxcontrib-spelling/) and can be installed via pip install sphinxcontrib-spelling. I would

Re: [sphinx-dev] Re: graphiz and LaTeX layout issue

2010-09-16 Thread Doug Hellmann
On Sep 12, 2010, at 3:50 PM, Guenter Milde wrote: On 2010-09-12, Kevin Dunn wrote: On Sat, Sep 11, 2010 at 14:38, Doug Hellmann doug.hellm...@gmail.com wrote: On Sep 11, 2010, at 2:35 PM, Doug Hellmann wrote: I've run into a problem with the graphviz extension and LaTeX output, similar

[sphinx-dev] graphiz and LaTeX layout issue

2010-09-11 Thread Doug Hellmann
I've run into a problem with the graphviz extension and LaTeX output, similar to the one described in this older thread http://groups.google.com/group/sphinx-dev/browse_thread/thread/b4d6b008d85e95a2/2b9a3bd468558cad?lnk=gstq=graphviz# I have this input: Consider this digraph:

[sphinx-dev] Re: graphiz and LaTeX layout issue

2010-09-11 Thread Doug Hellmann
On Sep 11, 2010, at 2:35 PM, Doug Hellmann wrote: I've run into a problem with the graphviz extension and LaTeX output, similar to the one described in this older thread http://groups.google.com/group/sphinx-dev/browse_thread/thread/b4d6b008d85e95a2/2b9a3bd468558cad?lnk=gstq=graphviz# I

Re: [sphinx-dev] 3rd party extensions

2010-07-21 Thread Doug Hellmann
On Jul 21, 2010, at 3:28 PM, Kevin Horn wrote: On Wed, Jul 21, 2010 at 1:19 PM, Sebastian Wiesner lunary...@googlemail.com wrote: Hi, http://bitbucket.org/birkenfeld/sphinx-contrib seems to be kind of semi-official third-party extension repository for Sphinx, some extensions developed

Re: [sphinx-dev] LaTeX references with page numbers

2010-07-02 Thread Doug Hellmann
On Jul 2, 2010, at 5:50 AM, Georg Brandl wrote: -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 01.07.2010 17:33, schrieb Doug Hellmann: OK, thanks. I'm still on 0.6.4 because of a dependency on an extension, so I guess this means I should port it to 1.0. :-) If you get stuck

Re: [sphinx-dev] LaTeX references with page numbers

2010-07-02 Thread Doug Hellmann
On Jul 2, 2010, at 1:32 PM, Doug Hellmann wrote: I'm using TeX Live 2007 for my LaTeX tools. I see on their website that there is now a 2009 edition, so maybe I need to update? I'll give that a try. Upgrading to TeX Live 2009 fixed the problem. Doug -- You received this message

Re: [sphinx-dev] LaTeX references with page numbers

2010-07-01 Thread Doug Hellmann
On Jun 20, 2010, at 8:20 AM, Georg Brandl wrote: Am 20.06.2010 14:06, schrieb Doug Hellmann: On Jun 20, 2010, at 6:21 AM, Georg Brandl wrote: Am 18.06.2010 16:14, schrieb Doug Hellmann: The cross-references work great as hyperlinks if you're reading a PDF online, but the printed

Re: [sphinx-dev] LaTeX references with page numbers

2010-06-20 Thread Doug Hellmann
On Jun 20, 2010, at 6:21 AM, Georg Brandl wrote: -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.06.2010 16:14, schrieb Doug Hellmann: The cross-references work great as hyperlinks if you're reading a PDF online, but the printed manuals just say Some Section Heading and don't help

[sphinx-dev] LaTeX references with page numbers

2010-06-18 Thread Doug Hellmann
I'm sorry if this is a FAQ or basic question, I tried to go look through the list archives, but groups.google.com is putting me into a redirect loop today. Is there a way to cause the LaTeX writer to generate internal references with page or section numbers in addition to hyperlinks?

Re: [sphinx-dev] Issue with numbering in latex output.

2010-02-13 Thread Doug Hellmann
On Feb 12, 2010, at 8:40 PM, Jason wrote: Windows XP, Python 2.6.4, Sphinx 0.6.4 I am currently struggling with an issue where numbered lists do not continue in latex output when interrupted by an admonition. For example, I have the following test: [...] This issue seems to be tied to

[sphinx-dev] Re: don't like automatic indexing feature

2009-10-04 Thread Doug Hellmann
On Oct 4, 2009, at 9:36 AM, j brandon keith wrote: Hi, I'm trying to do some automatic module generation. I've got some functions in a module I'd like to generate in one part: .. automodule:: pyre.inventory.__init__ :members: some-functions-here :undoc-members: and other functions

[sphinx-dev] Re: Entire document put into single chapter in latex

2009-09-28 Thread Doug Hellmann
On Sep 28, 2009, at 5:49 PM, Brian Granger wrote: Hi, The IPython project is using Sphinx for our documentation and it is working beautifully. The HTML look great, but when we create the latex/pdf version our entire manual appears in a *single chapter* in the PDF document. What we

[sphinx-dev] Re: Windows build issue

2009-09-23 Thread Doug Hellmann
On Sep 23, 2009, at 8:49 AM, yvesm wrote: On Sep 22, 3:52 pm, yvesm yves.moi...@boreal-is.com wrote: Now it's broken on my Ubuntu box too. What I did exactly : Just as I thought I had solved my issues last night (I basically deleted everything and ran sphinx-quickstart anew), I'm back at

[sphinx-dev] Re: noob question about autodoc

2009-08-13 Thread Doug Hellmann
On Aug 13, 2009, at 7:13 AM, northof40 wrote: ... the 0.py I'm using looks like this What does the rst file containing the autodoc directives look like? Doug --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google

[sphinx-dev] Re: Multiple document output

2009-08-04 Thread Doug Hellmann
On Aug 3, 2009, at 11:08 AM, genexp wrote: Hey Folks - I guess this is more of a how-best-to question than anything else. I have a doc tree I created with sphinx-quickstart. What I'd like to do, is create several final output documents base on the RST files organized in this project.

[sphinx-dev] Re: function directive in PDF output

2009-08-04 Thread Doug Hellmann
On Aug 4, 2009, at 5:56 PM, Georg Brandl wrote: Thanks, I've added the \leavevmode now in 0.6 and trunk. I was going to try to get to that later this week but you beat me to it! Do you have plans for a new 0.6 release soon? Thanks, Doug

[sphinx-dev] function directive in PDF output

2009-08-03 Thread Doug Hellmann
I'm working on some documentation that includes function signatures, and I need to ship it as a PDF. I have this in my rst file: .. function:: myFunc(token, imageId) Function description :param token: The token. :type token: string :param imageId: Identifier for the image.

[sphinx-dev] Re: function directive in PDF output

2009-08-03 Thread Doug Hellmann
On Aug 3, 2009, at 4:29 PM, Doug Hellmann wrote: On Aug 3, 2009, at 3:54 PM, Guenter Milde wrote: On 2009-08-03, Doug Hellmann wrote: Is anyone else seeing this problem? LaTeX does not start a new line after the key in a description list/definition list. While normally a feature

[sphinx-dev] Re: PDF generation on CentOS

2009-07-14 Thread Doug Hellmann
On Jul 14, 2009, at 9:47 AM, Santiago Suarez Ordoñez wrote: Looks like we're not in a Red Hat 5 as I stated, we're working on a RH4 box, which has an older version of TeTeX in the repo and from what the support guys say, there's no chance we can get TeTeX v 3 from the repo on it, the other

[sphinx-dev] Re: PDF generation on CentOS

2009-07-14 Thread Doug Hellmann
On Jul 14, 2009, at 10:10 AM, Santiago Suarez Ordoñez wrote: Thanks Doug. I'll try with a local install and see how that works. BTW, did I read 1.2 GB for the install? OMG!! That seems about right. You can also run it off of the DVD, IIRC, but I had space so ran through the installer.

[sphinx-dev] Re: How to specify templates to use?

2009-07-12 Thread Doug Hellmann
On Jul 10, 2009, at 9:32 AM, shabda raaj wrote: I want to use custom html templates with my sphinx docs. I did, 1. In conf.py added templates_path = ['_templates'] 2. Created a new _templates[at same level as conf.py] directory with layout.html, with my layout. My template was not

[sphinx-dev] Re: wiring sphinx into building source distros?

2009-06-30 Thread Doug Hellmann
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

new contrib module: paverutils

2009-06-05 Thread Doug Hellmann
I added paverutils to the sphinxcontrib repository this morning. paverutils provides an alternative integration of Sphinx and Paver. It supports calling Sphinx from within Paver using multiple configurations, and does not assume you only want to build HTML output. See either the home page

Re: Class name manipulation in autodoc

2009-05-20 Thread Doug Hellmann
On May 19, 2009, at 11:12 PM, Matthew Turk wrote: Hi there, Just as an upfront, I'm loving using sphinx to document a project. I'm writing because I'm stuck at a particular usage pattern we have in our code, and how to properly document it. We have objects that have affiliated derived

Re: How to set document title tag etc. for SEO

2009-05-08 Thread Doug Hellmann
On May 8, 2009, at 7:56 AM, Sanjay wrote: Hi, I am new to sphinx. Could not find how to set the title tag, meta tag etc. to make the site SEO friendly. Needing help. Would appreciate some clues. The title comes from the title of the document. I don't think the default sphinx

Re: Status update

2009-05-03 Thread Doug Hellmann
On May 3, 2009, at 5:54 AM, Christophe de VIENNE wrote: 2009/5/2 Georg Brandl ge...@python.org Now we have a few choices: - Keep the incompatibility. - Rename Sphinx' class. I don't have a suggestion for a better name though. I would go for this option (renaming). And I think it

Re: Status update

2009-05-03 Thread Doug Hellmann
On May 3, 2009, at 9:03 AM, James Rowe wrote: Is this going to be the Great Sphinx Bikeshedding of '09? :) * Doug Hellmann (doug.hellm...@gmail.com) wrote: On May 3, 2009, at 5:54 AM, Christophe de VIENNE wrote: 2009/5/2 Georg Brandl ge...@python.org - Rename Sphinx' class. I don't have

Re: reporting bug (??)

2009-05-01 Thread Doug Hellmann
On Apr 29, 2009, at 1:41 PM, Nichols A. Romero wrote: Sphinx v0.6.1 on mac OS X Exception occurred: 0%] contents File /Library/Frameworks/Python.framework/Versions/4.1.30001/lib/ python2.5/site-packages/Jinja2-2.1.1-py2.5-macosx-10.3-i386.egg/ jinja2/environment.py, line 357, in parse

Re: preprocessing hooks

2009-03-13 Thread Doug Hellmann
On Mar 13, 2009, at 6:24 AM, Michele Simionato wrote: I would like to use Sphinx to process my Adventures of a Pythonista in Schemeland (http://www.artima.com/weblogs/viewpost.jsp?thread=251474) and collect them in a nice hyperlinked document with search capabilities. Each Adventure is

Re: code examples: usability of html doctests

2009-02-10 Thread Doug Hellmann
On Feb 9, 2009, at 3:59 PM, Tim Michelsen wrote: Hello Sphinxers, I was asembling a set of tutorials and recipies. In order to make sure that every example I included in my code actually works, I included them as doctests like this is my example:: 1+1 In order to nable readers to

Re: Multiple folders for images

2009-01-22 Thread Doug Hellmann
On Jan 21, 2009, at 6:18 AM, Werner F. Bruhin wrote: I need different folders depending on what build I am running. I put the image folders into the conf folder, but it seems that the .. image:: and .. figure:: directives look relative to the source folder. So, I tried using a

Re: Multiple folders for images

2009-01-22 Thread Doug Hellmann
On Jan 22, 2009, at 10:41 AM, Werner F. Bruhin wrote: Doug Hellmann wrote: On Jan 21, 2009, at 6:18 AM, Werner F. Bruhin wrote: I need different folders depending on what build I am running. I put the image folders into the conf folder, but it seems that the .. image:: and .. figure

Re: Theming proposal

2009-01-05 Thread Doug Hellmann
On Jan 4, 2009, at 11:45 PM, Ian Bicking wrote: Doug Hellmann wrote: On Dec 30, 2008, at 3:38 PM, Gerard Flanagan wrote: While theme developers could use YUI or similar libraries or frameworks, I don't think Sphinx's default theme should depend on them. Doug Any particular reason

Re: Theming proposal

2008-12-21 Thread Doug Hellmann
On Dec 21, 2008, at 3:07 PM, Gerard Flanagan wrote: On Sat, 2008-12-20 at 23:24 +0100, Georg Brandl wrote: As I've announced a few times in the past, I want to add proper theming support to Sphinx 0.6. I've written a proposal outlining my intended implementation, below. I'm glad about

option list question

2008-11-03 Thread Doug Hellmann
I have an option list, formatted like: -h Displays abbreviated help message. --help Displays complete usage information. The output in HTML and PDF from version 0.4.2 shows the -- in front of --help converted to a single hyphen character. Am I leaving out some markup that would

Re: option list question

2008-11-03 Thread Doug Hellmann
, 2008 at 7:53 AM, Doug Hellmann [EMAIL PROTECTED] wrote: I have an option list, formatted like: -h Displays abbreviated help message. --help Displays complete usage information. The output in HTML and PDF from version 0.4.2 shows the -- in front of --help converted to a single

Re: option list question

2008-11-03 Thread Doug Hellmann
configuration file docs, smartypants, not smarty: html_use_smartypants If true, SmartyPants will be used to convert quotes and dashes to typographically correct entities. Default: True. On Mon, Nov 3, 2008 at 9:25 AM, Doug Hellmann [EMAIL PROTECTED] wrote: On Nov 3, 2008, at 11:04 AM, Bruce

Re: option list question

2008-11-03 Thread Doug Hellmann
On Nov 3, 2008, at 3:41 PM, Georg Brandl wrote: Bruce Eckel schrieb: I only know about it because I came across it while studying the Sphinx docs, and it mentioned that Smarty was used to do things like putting in smart quotes. Oops. It's in the build configuration file docs,

how do I create a preface?

2008-10-29 Thread Doug Hellmann
I have some generic information I would like to include in a preface for a manual I'm converting to PDF (stuff like Intended Audience, etc.). If I format my index.rst file like: ### Book Title ### == Intended Audience == Describe people who

Re: Single-File HTML Builder, Sphinx-Build Output, rst2pdf

2008-10-28 Thread Doug Hellmann
On Oct 28, 2008, at 10:36 PM, Max Battcher wrote: Yarko T wrote: As for PDF generation, just generate LaTeX and generate PDF from that (I do it on a PC w/ MikTeX driven by WinEdt - I know nothing about LaTeX, and it works great). The problem is not that the latex doesn't work, it's

Re: better css for the sidebar?

2008-10-27 Thread Doug Hellmann
I have custom index.html and layout.html templates for the PyMOTW site. I believe all of the necessary parts are included in the tarball with each release, but if not I'd be happy to provide them. http://www.doughellmann.com/PyMOTW/ On Oct 27, 2008, at 4:05 PM, Bruce Eckel wrote: It would

Re: Python programs are not always getting pygmentized

2008-10-20 Thread Doug Hellmann
On Oct 19, 2008, at 3:54 PM, Bruce Eckel wrote: Not really clear why it works most of the time, and not some of the time. There's a syntax error in quickPython/strings.py and the version of that file embedded in the text in quickPython/quickPython.rst. When I fixed the Print on line 6