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=gst&q=graphviz#
I have this input:
Consider this digraph:
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=
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 wrote:
>>> On Sep 11, 2010, at 2:35 PM, Doug Hellmann wrote:
>
>>>> I've run into a problem with the graphviz extension and
On Sep 16, 2010, at 8:51 AM, Doug Hellmann wrote:
>
> 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
>>> wrote:
>>>> On Sep 11, 2010, at 2:35 PM, Doug Hell
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 appreci
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 text
On Sep 10, 2008, at 11:16 AM, chris wrote:
>
> This would be great added functionality. My only concern would be the
> dependencies when distributing something. I think it's more likely
> that that people (at least in my audience) would have latex installed
> than ReportLab.
I recently started
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 lin
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
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 w
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
On Nov 1, 2008, at 10:26 AM, Georg Brandl wrote:
>
> You could use one of the "body element" directives topic, sidebar or
> rubric,
> documented here:
> http://docutils.sourceforge.net/docs/ref/rst/directives.html#body-elements
Thanks! It looks like rubric will probably create the output I'm
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 w
lists?
>
>
> On Mon, Nov 3, 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.
>
's in the build 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
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 f
On Nov 20, 2008, at 10:07 AM, Yarko Tymciurak wrote:
> Oh! I thought docstrings to set the language / encoding of the
> file (self-document), with the directories just containing fully
> translated sources - entire copies of the work.
>
> That seems simple, and ultimately sufficient. It's
On Nov 21, 2008, at 2:55 PM, Janet Swisher wrote:
>
> I'm looking for suggestions on how to deal with a problem I'm running
> into with how I'm using Sphinx and autodoc, although the software
> itself is working just fine.
Could you use an include directive instead of autodoc?
--~--~-
On Nov 26, 2008, at 7:28 PM, Mark Eichin wrote:
> Speaking of the emacs mode - anyone extended it to automatically
> adjust title-===-mark lengths?
>
The version I downloaded does that already. I don't have it in front
of me, but I think the key-binding is C-c, C-a for "adjust title". It
On Dec 20, 2008, at 11:39 PM, Roger Binns wrote:
>
> -BEGIN PGP SIGNED MESSAGE-
> Hash: SHA1
>
> Georg Brandl wrote:
>> I'm glad about every comment and criticism.
>
> One thing to consider is that some us are unable to create themed
> content due to not being artistic enough. Generally
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 gl
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? It is BSD licensed. I like it a lot, I have to
> say.
I
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 th
It shouldn't matter what level section you're linking to. Can you
post small examples of what works and what doesn't?
On Jan 7, 2009, at 10:21 AM, Paulette wrote:
>
> I recently started using Sphinx as we are developing a new software
> project where I work. I created a project in Sphinx and
On Jan 9, 2009, at 6:53 AM, Chris h wrote:
> On Friday 09 January 2009 01:22:22 Yarko Tymciurak wrote:
>> can you post your index and 2 test files here (if you reply by
>> email, you
>> can make attachments)?
>
> OK lets see if these come through. tks for the help.
>
>
> .. test documentation
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 usin
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
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
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 Adve
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, i
On May 3, 2009, at 5:54 AM, Christophe de VIENNE wrote:
>
>
> 2009/5/2 Georg Brandl
>
> 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 is a
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
>>>>
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
On May 13, 2009, at 3:31 AM, Georg Brandl wrote:
>
> Looking at Python naming tradition, both "type" and "classobj" would
> be
> candidates. "klass" is also commonly used when a Python identifier is
> called for, but of these, only "classobj" would be possible I think.
"classobj" is good, bu
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 "de
On May 22, 2009, at 12:34 PM, Georg Brandl wrote:
>
> Doug Hellmann schrieb:
>>
>> On May 13, 2009, at 3:31 AM, Georg Brandl wrote:
>>
>>>
>>> Looking at Python naming tradition, both "type" and "classobj" would
>&
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 or
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
--~--~-
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
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 o
o ran through the installer.
Doug
>
> Saludos
> Santi
>
>
>
> On Tue, Jul 14, 2009 at 10:56 AM, Doug Hellmann > wrote:
>>
>>
>> On Jul 14, 2009, at 9:47 AM, Santiago Suarez Ordoñez wrote:
>>
>>>
>>> Looks like we're not in a Red Hat 5
On Jul 21, 2009, at 10:53 AM, vm wrote:
>
> Hi
>
> I'm trying to index a bunch of mailboxes (mbox format) using Sphinx. I
> have been successful in parsing the mbox files and creating a Sphinx
> index with fields for 'mbox_name', 'from', 'to', 'subject', 'body' and
> 'date'. I have used the xmlp
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.
On Aug 3, 2009, at 3:54 PM, Guenter Milde wrote:
>
> On 2009-08-03, Doug Hellmann wrote:
>
>> 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:: myFu
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 t
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 proj
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
--~--~-~--~~~---~--~-
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 Group
On Aug 13, 2009, at 4:22 PM, northof40 wrote:
>
>
>
> On Aug 14, 3:26 am, Doug Hellmann wrote:
>> 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 autod
On Sep 23, 2009, at 8:49 AM, yvesm wrote:
>
> On Sep 22, 3:52 pm, yvesm 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 square
> one this
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 w
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 f
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 sph
On Apr 19, 2010, at 3:19 PM, adball wrote:
Where I work we have a base project and several customized projects
that extend and customize it for the needs of particular customers.
We have documentation in Sphinx for the base project and for many of
the custom projects as well.
I would really li
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?
I'm
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"
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 pr
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 wi
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 th
On Jul 21, 2010, at 3:28 PM, Kevin Horn wrote:
> On Wed, Jul 21, 2010 at 1:19 PM, Sebastian Wiesner
> wrote:
> Hi,
>
> http://bitbucket.org/birkenfeld/sphinx-contrib seems to be kind of
> semi-official third-party extension repository for Sphinx, some
> extensions developed in this repository
60 matches
Mail list logo
