Re: Latex fails if cmdoption contains |

2009-03-07 Thread Guenter Milde
On 2009-03-05, Christophe de VIENNE wrote: Hi, When using the following directive, make pdf fails with a ! Undefined control sequence. : .. cmdoption:: --startup manual|auto|disabled If I replace the '|' with ',' the error vanish. the | character must be input as \textbar in LaTeX. If

PyLit is using Sphinx

2009-03-07 Thread Guenter Milde
Dear Sphinx developers, dear Georg, the new version of the PyLit documentation at http://pylit.berlios.de is generated by Sphinx. PyLit (Python Literate) provides a plain but efficient tool for literate programming: a `bidirectional text/code converter`_. .. _bidirectional text/code converter:

Re: In what format should I maintain an image?

2009-03-09 Thread Guenter Milde
On 2009-03-09, Georg Brandl wrote: Cameron Laird schrieb: I have diagrams that are best maintained as vector-based graphics, though. How does Sphinx handle that? Are there Sphinx automations for transformation of SVG to TeX or images embeddable in HTML? Is the Sphinx attitude, use a

Re: Escaping 's with :ref: directive

2009-03-09 Thread Guenter Milde
On 2009-03-09, Georg Brandl wrote: Guenter Milde schrieb: The names are transformed to conform to the regular expression [a-z](-?[a-z0-9]+)* ... So, _foo or :ref:`foo` should work (as long as there is no other hyperlink targed called foo). :ref: refers to explicit labels only

Re: Link to Local Files

2009-03-14 Thread Guenter Milde
On 2009-03-13, Felix Hummel wrote: Is it possible to link to a local non-rest file? Yes of course, just use the normal rst syntax for links:: a link_ or an `anonymous link myfile.sh`_ or a link to `another-file.py`_. .. _link: ../still-another-file.tex My use case: Now I'd

Re: new exporter/builder : context

2009-03-19 Thread Guenter Milde
On 2009-03-18, Shubacka wrote: For making the pdf, I would know if it's possible to develop an exporter/builder to context (macro-package on top of tex, ... Do you mean Context? ... is it possible to copy/alter the latex one for making a context builder? It is possible but it is a lot of

Filenames in Search without extension

2009-03-20 Thread Guenter Milde
I generated the doc for http://pylit.berlios.de with Sphinx and on the Server, searching works fine. However, Search in the local mirror does not work, as the links to the search results do not contain the .html filename extension. Is this a bug or intended? How can I change this? (Defining

Re: Filenames in Search without extension

2009-03-24 Thread Guenter Milde
On 2009-03-24, Georg Brandl wrote: Guenter Milde schrieb: However, Search in the local mirror does not work, as the links to the search results do not contain the .html filename extension. Which version do you use? This is a known bug in at least 0.5.0 but fixed in the latest 0.5.2. I am

Re: question regarding contents directive

2009-03-25 Thread Guenter Milde
On 2009-03-24, Georg Brandl wrote: Guenter Milde schrieb: On 2009-03-24, Georg Brandl wrote: andreash schrieb: How can I tell Sphinx that it shall not display the Heading in the contents directive? Use the local option: Does this work for the toctree too? toctree only displays

Re: LaTeX customization

2009-03-31 Thread Guenter Milde
On 2009-03-30, Dan Craig wrote: I plan on bringing sphinx into my company, but I need to be able to make the printed documents look like company documents, which currently use a MS Word template. I'm sure there's a way to do it in LaTeX, but being a LaTeX noob, I'm looking for guidance. So

Re: LaTeX customization

2009-04-04 Thread Guenter Milde
On 2009-03-30, Jean Daniel wrote: Is there a best practice to latex template customization so that we don't screw the build chain? I can read python and latex but which files are involved? The best place for customization is in a latex preamble file that can be specified in conf.py as

Re: Remove blank pages from PDFs

2009-04-08 Thread Guenter Milde
On 2009-04-07, Maxim Khitrov wrote: When using the 'manual' latex documentclass, the resulting pdf documents have blank pages added after contents and at the end of every chapter. Is there any way to remove those? As an alternative, is it possible to use the 'howto' class, but have each

Re: Remove blank pages from PDFs

2009-04-14 Thread Guenter Milde
On 2009-04-09, Maxim Khitrov wrote: On Thu, Apr 9, 2009 at 3:30 PM, Georg Brandl ge...@python.org wrote: Actually, it looks like the value should be ',openany'. Without that comma, I get this at the top of the index.tex file: \documentclass[letterpaper,10ptopenany]{manual} Once the comma

Re: Remove blank pages from PDFs

2009-04-17 Thread Guenter Milde
On 2009-04-15, Maxim Khitrov wrote: On Tue, Apr 14, 2009 at 5:29 AM, Guenter Milde wrote: On 2009-04-09, Maxim Khitrov wrote: On Thu, Apr 9, 2009 at 3:30 PM, Georg Brandl ge...@python.org wrote: Actually, it looks like the value should be ',openany'. Without that comma, I get

how to set/fix the latex documentclass (was: Remove blank pages from PDFs)

2009-04-20 Thread Guenter Milde
On 2009-04-17, Fred Drake wrote: On Fri, Apr 17, 2009 at 4:12 AM, Guenter Milde mi...@users.berlios.de wrote: Also, it loads the 'report' standard LaTeX documentclass with the openright option hard-coded I said my lack for LaTeX-fu would come into play on this. :-( If anyone knows how

Re: copyright in latex/pdf output?

2009-04-22 Thread Guenter Milde
On 2009-04-22, John H Palmieri wrote: I have a Sphinx project with a line copyright = u'blah blah blah' in conf.py, and the appropriate string appears in the html output, but not in the latex file. Should it? If not, any suggestions for workarounds? Use the rst syntax for bibliographic

Re: Patch: Produce valid xhtml for toc-backreffed and permalinked titles

2009-04-22 Thread Guenter Milde
On 2009-04-19, Tuomas Räsänen wrote: In version 0.6.1 sphinx/writers/html.py HTMLTranslator.depart_title does not take into account the situation where a title is a backref-link to toc and has also a permalink, i.e. the text of h-tag consists of two separate links. Therefore Sphinx's

Re: how to set/fix the latex documentclass

2009-05-02 Thread Guenter Milde
On 2009-05-02, Georg Brandl wrote: Guenter Milde schrieb: I could find out and maybe even fix the manual.cls latex documentclass. However, I would rather find out who is in charge of this file. It's in charge of whoever writes patches :) * Where to send patches? Here, or to me directly

Re: Status update

2009-05-03 Thread Guenter Milde
On 2009-05-03, James Rowe wrote: * Georg Brandl (ge...@python.org) wrote: * The docutils people have come across Sphinx' redefinition of the class directive; they don't like that very much. I'm to blame, since I didn't remember/know about docutils' class when adding these directives to

Re: Status update

2009-05-04 Thread Guenter Milde
On 2009-05-03, James Rowe wrote: --C7zPtVaVf+AK4Oqc Content-Type: text/plain; charset=utf-8 Content-Disposition: inline * James Rowe (jnr...@gmail.com) wrote: I think for all intents and purposes it currently is that compatible, in my opinion `cssclass' is not something that is used

Re: Centering figures in LaTeX output

2009-05-05 Thread Guenter Milde
On 2009-05-01, Janet Swisher wrote: On Sun, Nov 16, 2008 at 11:53 AM, Georg Brandl ge...@python.org wrote: Ananth schrieb: .. _fig-dial: .. figure:: figs/my-fig.png    :align: center    :alt: my fig   My figure My figure :ref:`fig_dial`. - The figures that are generated in latex

Re: how to set/fix the latex documentclass

2009-05-06 Thread Guenter Milde
On 2009-05-02, Georg Brandl wrote: On Fri, Apr 17, 2009 at 4:12 AM, Guenter Milde wrote: Also, it loads the 'report' standard LaTeX documentclass with the openright option hard-coded ... If anyone knows how to make it pass those settings along only if it gets them, that would be great

Re: how to set/fix the latex documentclass

2009-05-07 Thread Guenter Milde
On 2009-05-06, Guenter Milde wrote: On 2009-05-02, Georg Brandl wrote: Also, it loads the 'report' standard LaTeX documentclass with the openright option hard-coded While possible (with some LaTeX magic), the most easy and maintable method will be to provide openright and twoside

Re: Centering figures in LaTeX output

2009-05-11 Thread Guenter Milde
On 2009-05-08, Janet Swisher wrote: On Tue, May 5, 2009 at 4:03 AM, Guenter Milde mi...@users.berlios.de wrote: On 2009-05-01, Janet Swisher wrote: On Sun, Nov 16, 2008 at 11:53 AM, Georg Brandl ge...@python.org wrote: Ananth schrieb: - The figures that are generated in latex seem

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

2009-05-11 Thread Guenter Milde
On 2009-05-11, Sanjay wrote: Hi Doug Georg, Thanks for the useful inputs. The title comes from the title of the document. As I know, the first line becomes the title. Is there a way to set invisible titles so that more words can be injected to make it SEO friendly? In Docutils, you

Re: autodoc and optparse

2009-05-12 Thread Guenter Milde
On 2009-05-11, Timmie wrote: Hello, can the autodoc/autosummary be extended to show command line options? Should be very easy if you use an option list: I would like to document command line scripts: print.py --help Autodoc could then parse the CLI scripts with the --help option and

Re: Centering figures in LaTeX output

2009-05-13 Thread Guenter Milde
On 2009-05-13, Georg Brandl wrote: Guenter Milde schrieb: However, the arbitrary alignment of the caption is a `known Docutils bug`__ that I am currently working on. The solution is to use the caption LaTeX package and explicitly set the alignment. Actually, the situation is a bit more

Re: Builder specific content

2009-05-14 Thread Guenter Milde
On 2009-05-13, juha.p.musto...@gmail.com wrote: I'm not sure if I remember incorrectly, but is there a way to write builder specific content If you look into the Docutils documentation of directives, you will find .. raw:: html Only shown in html output Günter

Re: class renaming - feedback needed!

2009-05-14 Thread Guenter Milde
On 2009-05-13, sffjunkie wrote: Or the Docbook tag 'ooclass' +1 Looking how this is solved by others seems the best choice. Günter --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups sphinx-dev group. To post to

Re: Controlling the scale of latex images

2009-05-18 Thread Guenter Milde
On 2009-05-18, Gael Varoquaux wrote: The images in the Latex are too big for my needs. I'd like to modulate their scale with a global value. Specificaly, I'd like a switch in the conf.py to change the '100.0' of sphinx/writers/latex.py, line 842 into something else that I can control, and

Re: Sphinx and XeTeX

2009-05-18 Thread Guenter Milde
On 2009-05-18, Leandro Lucarella wrote: I'm trying to render some Unicode art drawings with the LaTeX writer. I had some errors and found that LaTeX has some problems using unicode, but XeTeX can handle them. I hardly know LaTeX and never used XeTeX, does anyone have some experience using

Re: Controlling the scale of latex images

2009-05-19 Thread Guenter Milde
On 2009-05-19, Guenter Milde wrote: On 2009-05-19, Gael Varoquaux wrote: On Tue, May 19, 2009 at 05:50:59AM +, Guenter Milde wrote: * using a stylesheet and re-defining the \scalebox command ... That's an option, althought it feels like a gludge. I found the right way in grfguide.pdf

Re: Controlling the scale of latex images

2009-05-19 Thread Guenter Milde
On 2009-05-19, Gael Varoquaux wrote: On Tue, May 19, 2009 at 11:26:03AM +, Guenter Milde wrote: On 2009-05-19, Guenter Milde wrote: On 2009-05-19, Gael Varoquaux wrote: On Tue, May 19, 2009 at 05:50:59AM +, Guenter Milde wrote: * using a stylesheet and re-defining the \scalebox

Re: Image/figure alignment

2009-05-24 Thread Guenter Milde
On 2009-05-21, Leandro Lucarella wrote: Hello, I'm having some trouble trying to center images/figures (latex ouput). I saw that there were a recent discussion about this, and some changes proposed for rest itself. I read the discussions in this list and in docutils-develop but got a little

Re: Controlling the scale of latex images

2009-05-24 Thread Guenter Milde
On 2009-05-21, Leandro Lucarella wrote: Guenter Milde, el 19 de mayo a las 11:26 me escribiste: Most of the keyval keys used in the graphicx package may also be set using the command \setkeys provided by the keyval package. so for your scaling, the default value can be set

Re: Image/figure alignment

2009-05-25 Thread Guenter Milde
Guenter Milde, el 24 de mayo a las 20:31 me escribiste: On 2009-05-21, Leandro Lucarella wrote: To get you started about tweaking rst-generated LaTeX, the Docutils LaTeX writer documentation http://docutils.sf.net/docutils/docs/user/latex.html might be useful. Please ask at the docutils

how to get up link in the navigation bar?

2009-05-26 Thread Guenter Milde
Dear List, for my project i would like to complet the previous | next links in the navigation bar with an up linke like up | previous | next if I am below top level in the document hierarchy. I currently use:: !-- Navigation bar-- !--

Re: Centering figures in LaTeX output

2009-05-27 Thread Guenter Milde
On 2009-05-13, Georg Brandl wrote: Guenter Milde schrieb: However, the arbitrary alignment of the caption is a `known Docutils bug`__ that I am currently working on. The solution is to use the caption LaTeX package and explicitely set the alignment. When you've fixed it, please point me

Re: Controlling the scale of latex images

2009-05-29 Thread Guenter Milde
On 2009-05-25, Leandro Lucarella wrote: Guenter Milde, el 24 de mayo a las 20:34 me escribiste: On 2009-05-21, Leandro Lucarella wrote: Guenter Milde, el 19 de mayo a las 11:26 me escribiste: Most of the keyval keys used in the graphicx package may also be set using the command

[sphinx-dev] Re: Correct use of * * in source docs.

2009-06-10 Thread Guenter Milde
On 2009-06-10, victor adan wrote: Now I have a question about recommended use of * * (emphasis). The Sphinx doc site says: Sphinx uses interpreted text roles to insert semantic markup into documents. Variable names are an exception, they should be marked simply with *var*. I disagree with

[sphinx-dev] Re: Latex elastic spaces widows and orphans

2009-06-12 Thread Guenter Milde
On 2009-06-12, Pauli Virtanen wrote: Hi, I see sphinx.sty specifies \parskip = 2mm This is bad, since keeping the parskip *exactly* at 2mm prevents Latex from adjusting the whitespaces when it detects widow and orphan lines. Could this be replaced with an elastic space,

[sphinx-dev] Re: Chapter numbering in latex

2009-06-15 Thread Guenter Milde
On 2009-06-12, David Huard wrote: My sections in the latex output are numbered as 0.1, 0.2, etc, while I'd like them to be numbered as 1, 2, 3. I built the sphinx documentation in latex to look for an example on how to do things properly, but the sections are also numbered as 0.1, 0.2, ...

[sphinx-dev] Re: [PATCH] German translation updated

2009-06-16 Thread Guenter Milde
On 2009-06-15, Herbert Griebel wrote: German translation updated Thanks. Most changes bring a real improvement. ... #: sphinx/directives/other.py:193 msgid Section author: -msgstr Autor des Abschnitts: +msgstr Autor des Kapitels: Please make sure not to mix chapter (Kapitel) and

[sphinx-dev] Re: latex: too deeply nested

2009-06-16 Thread Guenter Milde
On 2009-06-15, Georg Brandl wrote: Timmie schrieb: when running make all-pdf in the build/latex direcory I get an error saying: too deeply nested. I do not understand this as latext supports nesting down to the paragraph level. Where can I improve? Add levels on top: * Use a

[sphinx-dev] Re: latex: too deeply nested

2009-06-16 Thread Guenter Milde
On 2009-06-15, Tim Michelsen wrote: Keep in mind that section numbers are not assigned per source file, but once for the whole latex file that is generated by Sphinx. So if you have further headings in the files that include that one by toctree, it will count as well. Thanks a lot for the

[sphinx-dev] Re: [PATCH] German translation updated

2009-06-16 Thread Guenter Milde
On 2009-06-16, Herbert Griebel wrote: #: sphinx/directives/other.py:193 msgid Section author: -msgstr Autor des Abschnitts: +msgstr Autor des Kapitels: Please make sure not to mix chapter (Kapitel) and section (Abschnitt). These are different levels of sectioning. (With chapter

[sphinx-dev] Re: OK, Q == 17 and A == 1, but I just want a simple QA...

2009-06-16 Thread Guenter Milde
On 2009-06-16, Pauli Virtanen wrote: Mon, 15 Jun 2009 23:19:59 -0400, sstein...@gmail.com kirjoitti: Ok, I'm not sure how to solve this... Q. some question A. some answer \Q. some question \A. some answer

[sphinx-dev] Re: tml table formatting

2009-06-17 Thread Guenter Milde
On 2009-06-17, James Evans wrote: Hello, I am trying to make a table similar to the following: ... Where the first column is right-aligned and the second column is left-aligned. I do not want this for every table in my docs, so a simple CSS hack is out (unless I could specify a css class

[sphinx-dev] Re: tml table formatting

2009-06-18 Thread Guenter Milde
On 2009-06-18, James Evans wrote: That does not seem to work, since all that does is add the text columns-lr to the output document with the same formatting that would occur for any given '.. class::' directive. Ah yes, the class name clash. AFAIK, in Sphinx it is .. cssclass::

[sphinx-dev] Re: References in doc strings got a strange formatting

2009-06-23 Thread Guenter Milde
On 2009-06-22, Simon King wrote: Hi! In some doc string, I have: ... .. [Wilkerson] Clarence Wilkerson, *A primer on the Dickson invariants,* Proceedings of the Northwestern Homotopy Theory Conference (Evanston, Ill., 1982), *Contemp. Math.,* **19** (1983), 421--434. ... ... After

[sphinx-dev] Re: The right way to use a custom latex stylesheet in place sphinx.sty

2009-06-29 Thread Guenter Milde
On 2009-06-26, Wolfram Riedel wrote: On Jun 26, 8:28 pm, chip chipweb...@gmail.com wrote: I made some tweaks to the latex stylesheet sphinx.sty and I am trying to determine the right way to handle these changes.  Of course I can keep the modified sphinx.sty in my installation, but it seems

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

2009-08-03 Thread Guenter Milde
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:: myFunc(token, imageId) Function description :param token: The token. :type token: string

[sphinx-dev] Re: A test document

2009-08-03 Thread Guenter Milde
On 2009-07-29, Roberto Alsina wrote: On Wednesday 29 July 2009 00:37:45 Roger Binns wrote: Santiago Suarez Ordoñez wrote: I'm sorry I never got the time to try it myself, but you can test it using Selenium's doc: Right. And also, it helps if it' s not too repetitive. Why not start with

[sphinx-dev] Re: using marvosym symbols

2009-08-03 Thread Guenter Milde
On 2009-07-10, Gour wrote: On Jul 9, 11:14 pm, Georg Brandl ge...@python.org wrote: In that case, it would be best to use Unicode characters and add them to sphinx.util.texescape in an extension: from sphinx.util.texescape import tex_replacements def setup(app):    

[sphinx-dev] Re: Wrong PDF link targets

2009-08-03 Thread Guenter Milde
On 2009-07-10, Wolfram Riedel wrote: Hi. It seems that in LaTeX generated PDFs, internal links to a chapter (which begins on a new page) do actually point to the page before this chapter. I anchor them with .. _my_chapter: right above the title, and link with :ref:`my_chapter`. Is there

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

2009-08-04 Thread Guenter Milde
On 2009-08-03, Doug Hellmann wrote: 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: LaTeX does not start a new line after the key in a description list/definition list. While normally a feature

[sphinx-dev] Re: Wrong PDF link targets

2009-08-06 Thread Guenter Milde
On 2009-08-04, Wouter van Heyst wrote: On Mon, Aug 03, 2009 at 08:14:12PM +, Guenter Milde wrote: On 2009-07-10, Wolfram Riedel wrote: It seems that in LaTeX generated PDFs, internal links to a chapter (which begins on a new page) do actually point to the page before this chapter. I

[sphinx-dev] Re: Citations / bibtex

2009-08-18 Thread Guenter Milde
On 2009-08-18, Eric Jonas wrote: This seems to come up from time to time, and from googling it is not clear that there was ever a recommended / definitive solution. I'd like to do the following:: This is a statement that may be controversial [MyAdvisor08]_. And end up with: 1. The

[sphinx-dev] Re: raw external file in preformatted style

2009-08-20 Thread Guenter Milde
On 2009-08-19, Jean Daniel wrote: Hello, I would like to include in my pdf an external file. It is some text which should not be interpreted, just included as is preferably in preformatted style. The documentation seems to say this is the way: .. raw:: html :file: inclusion.html

[sphinx-dev] Re: images in numbered lists

2009-08-21 Thread Guenter Milde
On 2009-08-21, Samuel wrote: Hi Guys, I'm adding figures in between some numbered steps like so: --- 4. Ensure that the clips are in position as shown in figure 3. .. ifconfig:: mytest=='cond1' .. figure:: _static/image022.jpg .. ifconfig::

[sphinx-dev] Re: Colored Font

2009-08-23 Thread Guenter Milde
On 2009-08-18, Brian Cole wrote: I want to color a few words in a restructured text paragraph. However, I can't find any way to color text. I know sphinx/restructured text can do it since it will syntax highlight blocks of code. I will create my own role to do it if I have to, but I would

[sphinx-dev] Re: Slideshow with Sphinx

2009-08-24 Thread Guenter Milde
On 2009-08-21, Bartosz wrote: Dear all, I am working on a presentation about Python. The presenation includes both text and Python snippets intermixed. I want to be able to highlight the code and test the snippets automatically, which could be done with Sphinx. Is it possible to generate

[sphinx-dev] Re: captions for literal blocks in ReST

2009-08-31 Thread Guenter Milde
On 2009-08-31, Chris Withers wrote: Guenter Milde wrote: I would rather nest the literal block in a directive, a topic, say:: .. topic:: myfile.py :: class MyClass: def something(self): pass These all sound equally fine, however, in each case

[sphinx-dev] Re: captions for literal blocks in ReST

2009-09-01 Thread Guenter Milde
On 2009-09-01, Chris Withers wrote: Guenter Milde wrote: On 2009-08-31, Chris Withers wrote: Guenter Milde wrote: Okay, I think I get this, but why the double colon on its own line? I would rather nest the literal block in a directive, a topic, say

[sphinx-dev] Re: Problems with embedded math

2009-09-11 Thread Guenter Milde
On 2009-09-11, Florian Lindner wrote: Hello, I try to use math in my docstrings: def fp_out(self): .. math:: M_2 = \frac{M^2 \cdot (\kappa-1)+2}{\kappa (2 M^2-1)+1}} k = self.f_prop.kappa I've activated the pngmath extension

[sphinx-dev] Re: Selectively auto-numbering sections

2009-09-16 Thread Guenter Milde
On 2009-09-15, jkleint wrote: Hello, I'd like to use ..sectnum:: to auto-number the sections of my document. However, this auto-numbers my title and introduction as well, which I don't want. Is there a way to exclude certain sections from auto numbering? Not directly. However, you can

[sphinx-dev] Re: forcing page breaks

2009-09-22 Thread Guenter Milde
On 2009-09-21, Tom Hoffman wrote: On Mon, Sep 21, 2009 at 2:45 PM, Roberto Alsina rals...@netmanagers.com.ar wrote: On Monday 21 September 2009 15:05:00 Tom Hoffman wrote: Hi all, Is there any way to force page breaks in pdf generation? Via latex or via rst2pdf? Well... just generally

[sphinx-dev] Re: forcing page breaks

2009-09-22 Thread Guenter Milde
On 2009-09-22, Max Battcher wrote: On 9/21/2009 19:35, Max Battcher wrote: .. cssclass:: pagebreak Or just .. class:: once the code directive renaming takes place, of course. Paragraph or section or whatever... Then add to the stylesheet: .pagebreak { page-break-before: always }

[sphinx-dev] Re: Right way to customizing latex output - lines between table rows

2009-09-25 Thread Guenter Milde
On 2009-09-25, Chip Webber wrote: I do not think that constructing the table using this syntax implies that a there should be a line between each row. There are several different ways to make a table in RST, but at the end of the day they are all just tables. My understanding is that

[sphinx-dev] Re: Section headings in docstrings

2009-10-03 Thread Guenter Milde
On 2009-10-03, Oben wrote: In my workflow I really prefer to have all documentation in the source file and thus would benefit from sections in docstrings. You might consider using PyLit (http://pylit.berlios.de). Günter --~--~-~--~~~---~--~~ You received

[sphinx-dev] Re: Page hierarchy in sidebar

2009-10-07 Thread Guenter Milde
On 2009-10-08, schoenborno wrote: Sphinx is a great doc tool, but I find it really strange how it presents TOC in sidebar. It is pretty much the norm to have some form of page hierarchy type TOC in a sidebar (or topbar) always visible at left/right or top of site, to help navigate a site.

[sphinx-dev] Re: why does sphinx eat traceback lines?

2009-11-11 Thread Guenter Milde
On 2009-11-10, Chris Withers wrote: Hi All, The following ReST: from testfixtures import compare compare(1, ... 2) Traceback (most recent call last): ... AssertionError: 1 != 2 ...is rendered by Sphinx as: from testfixtures import compare compare(1, ... 2)

[sphinx-dev] Re: documenting instance attributes

2009-11-11 Thread Guenter Milde
On 2009-11-09, Joshua Bronson wrote: I'd like to be able to associate a docstring with an instance attribute in such a way that autodoc will discover it along with the rest of the documentation for the class's properties, methods, and class attributes. The following is the convention used

[sphinx-dev] Re: Centering a figure in HTML

2009-12-05 Thread Guenter Milde
On 2009-12-05, David Arnold wrote: All, How do you center a figure in HTML? See http://docutils.sourceforge.net/docs/ref/rst/directives.html#figure (Generic hint: With problems in the markup Sphinx inherits from Docutils, google for Docutils + your problem ( in this case figure directive).)

[sphinx-dev] Re: Adding a \cfoot{} in title apge

2009-12-05 Thread Guenter Milde
On 2009-12-04, Steph wrote: Hi, how to add a centered footer (\cfoot{myfooer}) to the first page (title page) without changing anything else in the document? This can be done with LaTeX code in the preamble (you will have to find out the code (depends on your documentclass) and add it to your

[sphinx-dev] Re: MathML

2009-12-06 Thread Guenter Milde
On 2009-12-05, Jeroen Ruigrok van der Werven wrote: -On [20091205 21:50], Guenter Milde (mi...@users.berlios.de) wrote: Can you explain, how a new HTML version will improve the support by existing browsers. HTML 5 has the support for SVG and MathML built in. And as far as my last reading

[sphinx-dev] Re: Single Side Latex Output

2009-12-08 Thread Guenter Milde
On 2009-12-08, akean wrote: On Dec 8, 11:56 am, Nahuel Defossé nahuel.defo...@gmail.com wrote: I've trying to hack the latex output, in manual document class so that page numbers are printed always in the same side. All I need is to print my document as a Single Sided document, but sphinx by

[sphinx-dev] Re: How do I set tab size in code snippets?

2009-12-08 Thread Guenter Milde
On 2009-12-08, Jason S wrote: On Nov 8, 10:11 am, Georg Brandl ge...@python.org wrote: You can do something like this in your conf.py: def setup(app):     from sphinx.highlighting import lexers     from pygments.lexers.compiled import JavaLexer     lexers['java'] = JavaLexer(tabsize=4)

[sphinx-dev] Re: literalinclude vs. include

2009-12-09 Thread Guenter Milde
On 2009-12-09, Jason S wrote: On Dec 9, 11:14 am, Jason S jmsa...@gmail.com wrote: Never mind, I figured something out. In my source .rst file, I changed .. literalinclude:: tennis.espdf to .. include:: tennis.espdf    :literal:    :tab-width: 3 Argh! include :literal: is perfect,

[sphinx-dev] Re: Disabling hyphenation

2009-12-10 Thread Guenter Milde
On 2009-12-09, Nahuel Defossé wrote: --0016e6db2b1c7704cb047a525236 Content-Type: text/plain; charset=ISO-8859-1 I have some trouble with Latex hyphenation in Sphinx. Is is possible to disable it via latex_preamble? Yes. But it might be better to solve your problems in the preamble instead

[sphinx-dev] Re: literalinclude vs. include

2009-12-10 Thread Guenter Milde
On 2009-12-10, Jason S wrote: On Dec 9, 4:20 pm, Guenter Milde mi...@users.berlios.de wrote: Argh! include :literal: is perfect, except that for some reason it's mucking with my quotes to make them angled. :-( Could you be more specific here? '' - '' or what? single quote ' straight-up

[sphinx-dev] Re: Adding Image to Attention/Warning directives

2009-12-21 Thread Guenter Milde
On 2009-12-20, nickmalcolm wrote: On 12/20/2009 17:57, MaX Battcher wrote: Just wondering where I would need to insert code so that I can include images in directives like Attention and Warning. At the moment you just get the Title and contents, I want to put an image next to the title.

[sphinx-dev] Re: rough cut at latex references/labels and hrefs for better printed output

2009-12-29 Thread Guenter Milde
On 2009-12-27, chrism wrote: FYI, I just made a rough cut at changing the latex writer to: - Add LaTeX references and labels (\pageref and \label). - Generate references after section header instead of before to make hyperlink jumping more correct. Did you have a look of the current

[sphinx-dev] Re: Altering LaTeX figure placement

2010-01-07 Thread Guenter Milde
On 2010-01-06, Mike Pumphrey wrote: --00c09f9b06270b6f7a047c84f1d3 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit We would like to change the arguments of the figure placement in the Sphinx LaTeX output. It seems like that the LaTeX output is

[sphinx-dev] Re: Generate zcode tutorials

2010-01-10 Thread Guenter Milde
On 2010-01-09, Natim wrote: I am using Sphinx because it is using ReST, building beautiful HTML and LaTeX documents. Many thanks to everyone who worked on this. Today, I want to use Sphinx to write a tutoriel about Django for the Siteduzero.com, a french growing website. I want to use

[sphinx-dev] Re: Creating documents other than technical documentation -- is there no interest in this regard?

2010-01-12 Thread Guenter Milde
On 2010-01-12, eegg wrote: A conclusion I've come to is that reST/sphinx can potentially provide a *complete* replacement of things like OpenOffice.org. In other words, I've found them to be ideal for the production non-technical documents. I see reST/sphinx as a friendly plaintext

[sphinx-dev] Re: broken start-after and end-before options for literalinclude directive

2010-01-29 Thread Guenter Milde
On 2010-01-28, Jean Daniel wrote: Here is a snippet of the index.rst::  Welcome to toto's documentation!    foo  .. literalinclude:: titi     :language: c     :start-after: 3  bar This is a syntax error. Don't use quotes around the 3. I have tried to

[sphinx-dev] Re: UnicodeEncodeError:

2010-01-29 Thread Guenter Milde
On 2010-01-27, olefoxe wrote: Hi, when i try to :make html I got this error: ... File /usr/lib/python2.5/site-packages/Sphinx-0.6.4-py2.5.egg/sphinx/ environment.py, line 751, in process_images if not os.access(path.join(self.srcdir, imgpath), os.R_OK): UnicodeEncodeError: 'ascii'

[sphinx-dev] Re: single column table vs. section header?

2010-02-03 Thread Guenter Milde
On 2010-02-02, Mark Harrison wrote: This came up in the course of generating some REST formatted tables: select foo,bar from baz; select foo from baz; === === === foo bar foo === === === 1 2 1

[sphinx-dev] Re: Non-trivial conditional include with ifconfig?

2010-02-05 Thread Guenter Milde
On 2010-02-05, Fernando Perez wrote: Hi all, I need to include some material (exercise solutions) for a doc build only in certain cases, ... But I actually need a section title, and calls to source code inclusion and math directives in there. I tried things like: .. ifconfig::

[sphinx-dev] Re: Ref to Numbered figure

2010-03-19 Thread Guenter Milde
On 3/10/2010 6:53 AM, annaR wrote: On 2010-03-18, Kevin Dunn wrote: On Wed, Mar 17, 2010 at 11:03, Mike Pumphrey m...@opengeo.org wrote: I use Sphinx to generate latex and html output from reST files. One of our users pointed out that the figures are numbered in latex however they are not

[sphinx-dev] Re: Problem while generating the latex output

2010-03-22 Thread Guenter Milde
On 2010-03-21, J Carlos Cardona wrote: chapter is not set correctly. Here is a minimal file I just created: -- the minimal file ... In the http output, everything is ok, but in latex is not. Can you post the LaTeX file? Günter -- You received this

[sphinx-dev] Re: quick question about compatibility

2010-03-24 Thread Guenter Milde
On 2010-03-23, j brandon keith wrote: hi...just a quick question which is probably obvious to somebody (but not me): how does sphinx do with supporting python 3.x Yes, i know it was used to build the docs and all for python 3.x and because of the way the interpreter works with the language

[sphinx-dev] Re: quick question about compatibility

2010-03-29 Thread Guenter Milde
On 2010-03-28, Lennart Regebro wrote: On Wed, Mar 24, 2010 at 11:08, Guenter Milde mi...@users.berlios.de wrote: AFAIK, you must convert the code with 2to3. This is automatically done, if you install with setuptools under Python 3. No, it's not automatically done. In fact, setuptools has

[sphinx-dev] Re: ReStructuredTextToolsForGedit

2010-03-30 Thread Guenter Milde
On 2010-03-30, werner wrote: I use UliPad, but it has the same limitations - it would be nice if there is a way to preview a single .rst file - with Sphinx directives also working, but I don't think there is such a build command in Sphinx at this time - would be very happy if someone would

[sphinx-dev] Re: citation with abbreviated first name interpreted as enumeration

2010-04-06 Thread Guenter Milde
On 2010-04-05, Max Battcher wrote: Václav Šmilauer wrote: 1. creating citations with sphinx, I have rst file with bibliography (generated from .bib file). I found that entries like: .. [Alonso2004] ⁢F. Alonso-Marroquín etc will apprear as [Alonso2004] 6. Alonso-Marroquín etc The

[sphinx-dev] Re: Flash animation in Sphinx output?

2010-04-07 Thread Guenter Milde
On 2010-04-07, Grammarian wrote: How can I embed a Flash animation into documentation produced by Sphinx? Maybe this could be done by porting the newly added support for swf images (objects) from Docutils (0.7-svn) to Sphinx? Günter -- You received this message because you are subscribed

[sphinx-dev] Re: How to extend docutils in sphinx

2010-04-07 Thread Guenter Milde
On 2010-04-06, Georg Brandl wrote: Am 06.04.2010 20:05, schrieb Roberto Alsina: I can't claim to know LateX but the latest docutils has a different visit_inline than Sphinx: ... Yes, because the issue of classified inline nodes was fixed after the fork of Sphinx and this fix (like many

[sphinx-dev] Re: Problem while generating the latex output

2010-04-09 Thread Guenter Milde
On 2010-04-07, g.bra...@gmx.net wrote: Guenter Milde mi...@users.berlios.de wrote: On 2010-04-07, Kevin Horn wrote: On Tue, Apr 6, 2010 at 3:23 AM, Guenter Milde Sphinx does not depend on Docutils but forked from it. Günter, I'm surprised that you're making such uninformed statements. I

[sphinx-dev] Re: SVG figures in Firefox

2010-04-14 Thread Guenter Milde
On 2010-04-13, Václav Šmilauer wrote: Hi there, I am not sure whether this is Firefox-specific... I am not able to see SVG figures in HTML output, with Firefox 3.6.3. It doesn't display anything at all, just blank space. Those SVG were created byt inkscape. Is it possible that Firefox is

  1   2   3   >