[sphinx-dev] Projects using Sphinx: Turbulenz SDK documentation

2012-10-08 Thread David Galeano
Hi, Just to let you know that we are using Sphinx for our Game Engine SDK documentation: http://docs.turbulenz.com/ As well as the online version we also ship the docs with our SDK, both in HTML form and as a single PDF file. Regards, David Galeano -- You received this message because

[sphinx-dev] Re: Minimum toolset need to run latex makefile and generate Sphinx PDF on Windows?

2012-09-19 Thread David
For me: Python, Sphinx, MikTex. 1. Run the make batch file for your Sphinx project: make.bat latex 2. Open Texworks 3. File > Open > myproject.tex 4. Choose pdflatex+makeindex+bibtex from the dropdown menu. 5. Press the green "play" button. 6. Press enter to continue processing

[sphinx-dev] Re: Annoucing robin, a new Doxygen to Sphinx bridge

2012-07-05 Thread David Leach
A minor suggestion then. From a project perspective, you probably wouldn't want to check in to your source archive something that is the output of a process (like running doxygen). I would think you would have a documentation build process that would make a doxygen pass over your code base to ge

Re: [sphinx-dev] autodoc and optional parameters

2012-07-04 Thread David Leach
Yeah, I was looking at the underlying code to autodoc and I think I see how to add support for this... But I'm not real proficient with python. It looks like autodoc uses the inspect module to get a clean string of the function prototype. If you then use string functions to search for '=' you c

[sphinx-dev] Re: Underfull \hbox (badness 10000) in paragraph at lines... in Sphinx 1.1.2

2012-01-02 Thread Stefano David
Hi, On Jan 1, 8:07 am, Kristina Hoeppner wrote: > Would anyone know what I am doing wrong here? As Marius said, this is due to "aesthetic reasons". I do not compile a latex source since a while (basically since I'm using sphinx), but if you compile the latex by hand and produce a .dvi, try to add

[sphinx-dev] issue with widgetbrowser

2011-10-18 Thread Stefano David
to 0.8.1 and the sys.path is correct, since the sphinx code compiles perfectly when a omit the widgetbrowser:: directive. Thank you in advance. Stefano David [1] http://toscawidgets.org/documentation/WidgetBrowser/embed.html#enable-the-extension *** full traceback*** # Sphinx version: 1.1

[sphinx-dev] Re: LaTeX fancy formatting for admonitions

2011-10-17 Thread Stefano David
Hi, On Oct 16, 1:19 am, Robin wrote: > Can you help me on this ? The "notice " environment is defined as follows in sphinx.sty: \newenvironment{notice}[2]{ \def\py@noticetype{#1} \csname py@noticestart@#1\endcsname \par\strong{#2} } you can modify it directly for all of your build, addin

[sphinx-dev] add option to directive

2011-10-16 Thread David Froger
ng directly the files sphinx/directives/code.py and sphinx/ext/mathbase.py) Thanks for your any help! Best, David. 1. an 'input' options to math that insert the lines of a file before the lines of the latex code, for example: .. math:: :nowrap: :input: macro.t

[sphinx-dev] non working todolist

2011-10-06 Thread Stefano David
Hi again, I have a small problem with todolists. Basically, I can not add a .. todolist:: directive anywhere in the code, because I always get this traceback: # Sphinx version: 1.0.1 # Docutils version: 0.7 release # Jinja2 version: 2.5.5 Traceback (most recent call last): File "/usr/lib/pymod

[sphinx-dev] Re: Strange behaviour of :abbr:

2011-09-23 Thread Stefano David
Hello! On Sep 23, 10:40 am, Georg Brandl wrote: > You're right, this was a bug in the regex I used.  It's now fixed and > will be released in 1.0.8 pretty soon. Thank you for your quick answer! Cheers, Stefano -- You received this message because you are subscribed to the Google Groups "sphi

[sphinx-dev] Strange behaviour of :abbr:

2011-09-23 Thread Stefano David
Hi, I started using sphinx around six months ago and find it easy to use and powerful. I found, however, a problem when using :abbr:and I do not know whether it is a bug or something I am missing. So, here's the point: Whenever I write, say :abbr:`SSH (Secure SHell)`, no problem, it works perfectly

[sphinx-dev] Parsing more than 1000 matches

2011-04-06 Thread david reis
Hi, I need to parse all my delta index, not limited to the first 1000 matches. I know that I can change max_match in sphinx.conf and in my script. But I don't want to do it that way because I need to parse 500 000 docs each time and it will to much. I can't find a way to parse the first 1000 match

[sphinx-dev] Parsing more than 1000 matches

2011-04-06 Thread david reis
Hi, I need to parse all my delta index, not limited to the first 1000 matches. I know that I can change max_match in sphinx.conf and in my script. But I don't want to do it that way because I need to parse 500 000 docs each time and it will to much. I can't find a way to parse the first 1000 match

[sphinx-dev] menuselection

2010-08-18 Thread David
All, The output of this command doesn't seem to be very good. Here is :menuselection:`File-->Save` D. -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe from this gro

[sphinx-dev] Re: :download: versus :doc:

2010-08-18 Thread David
Nope. But I get it now, as I got this to work: View :doc:`index`. Where index.rst is in the same directory as the calling file. D. On Aug 18, 3:14 pm, Kevin Horn wrote: > On Wed, Aug 18, 2010 at 5:09 PM, David wrote: > > All, > > > I'm not sure of the purpose of :d

[sphinx-dev] Re: :download: versus :doc:

2010-08-18 Thread David
Kevin, That's the page I am currently reading, where nothing is said in the :doc: description that it has to be a Sphinx document. Does that mean something like filename.rst? D. On Aug 18, 3:14 pm, Kevin Horn wrote: > On Wed, Aug 18, 2010 at 5:09 PM, David wrote: > > All, >

[sphinx-dev] Re: Figure captions

2010-08-18 Thread David
ly nice.  I haven't found a way to do it > so far (though admittedly it's not high on my priority list). > > Kevin Horn > > > > On Wed, Aug 18, 2010 at 4:31 PM, David wrote: > > All, > > > Is there a way to label Figures with automatic numbering, as in F

[sphinx-dev] Re: Indexing

2010-08-18 Thread David
Yep, That's the way I'm used to doing it in Latex, though as long as the containing paragraph is not too long, the current way seems fine. D. On Aug 18, 3:05 pm, Kevin Horn wrote: > On Wed, Aug 18, 2010 at 3:42 PM, David wrote: > > Hi, > > > Not sure about ind

[sphinx-dev] Re: :numbered:

2010-08-18 Thread David
Can an option be passed to "make html" ? David On Aug 18, 3:04 pm, Georg Brandl wrote: > -BEGIN PGP SIGNED MESSAGE- > Hash: SHA1 > > Am 18.08.2010 21:56, schrieb David: > > > > > > > All, > > > I have index.rst and intro.rst. In index

[sphinx-dev] :download: versus :doc:

2010-08-18 Thread David
m Bug? Or am I missing something. Not sure if I understand the difference between :doc: and :download:. David -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe fr

[sphinx-dev] Figure captions

2010-08-18 Thread David
All, Is there a way to label Figures with automatic numbering, as in Figure 1, Figure 2, Figure 3, etc.? So that if later I decide to insert another figure between Figure 2 and Figure 3, they will be automatically renumbered? David -- You received this message because you are subscribed to the

[sphinx-dev] Indexing

2010-08-18 Thread David
. Now is the time for all good men to come to the aid of their countrymen. Do I have this idea right? David -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubs

[sphinx-dev] :numbered:

2010-08-18 Thread David
All, I have index.rst and intro.rst. In index.rst, I have: .. toctree:: :maxdepth: 2 intro If I change this to: .. toctree:: :numbered: intro Then I get numbered sections and subsections. However, if I change this back to: .. toctree:: :maxdepth: 2

[sphinx-dev] Re: .. function example in documentation doesn't work for me

2010-08-18 Thread David
Ah, Maybe that is because it is not an example, but just a general description of how to use a directive? D. On Aug 18, 11:35 am, David wrote: > All, > > On:http://sphinx.pocoo.org/latest/rest.html#images > > This example: > > .. function:: foo(x) >              

[sphinx-dev] .. function example in documentation doesn't work for me

2010-08-18 Thread David
All, On: http://sphinx.pocoo.org/latest/rest.html#images This example: .. function:: foo(x) foo(y, z) :bar: no Return a line of text input from the user. Produces this warning and doesn't render on my Macbook Pro in Safari. /Users/darnold/Documents/temp/Sphinx/index.rst:7

[sphinx-dev] Re: MathJax

2010-08-17 Thread David
ad (quite a bit), MathJax has ways of configuring the mathematics, so I don't really see a need for the class="math" guys. But, I am very new to this. David. -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To

[sphinx-dev] Re: MathJax

2010-08-16 Thread David
e know that \(a^2+b^2=c^2\). \[(a+b)^2=a^2+2ab+b^2\] \[(a-b)^2=a^2-2ab+b^2\] Isn't the following all that is needed by MathJax? Since Pythagoras, we know that \(a^2+b^2=c^2\). Why the span and the class? David Arnold College of the Redwoods Eureka, CA 95501 -- You received this message beca

[sphinx-dev] MathJax

2010-08-16 Thread David
work with MathJax? David Arnold College of the Redwoods Eureka, CA 95501 -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe from this group, send email to

[sphinx-dev] Re: htmlhelp and mapid

2010-08-03 Thread David
t's not my day job. In the meantime, I'm still just adding code to the make.bat file to append hard-coded alias and ID data to the end of the .hhp file. Dave Parker On Aug 2, 10:42 am, David wrote: > Use the index directive to specify locations in the documentation you > would li

[sphinx-dev] Re: htmlhelp and mapid

2010-08-02 Thread David
ould appreciate any advice and guidance from the experienced Sphinx developers. Thanks, David Parker On Jun 12, 9:35 am, Troy wrote: > Is this even possible. I would like to switch from asciidoc/docbook > format to sphinx. I just need this one bit of information to > accomplish that

[sphinx-dev] Problem with mathmpl Sphinx extension

2010-07-14 Thread David
I'm using Python 2.6, Sphinx 1.0 and matplotlib 1.0.0 and have an issue I can't figure out using the mathmpl.py sphinx extension. The following math text seems to work fine in matplotlib (when used as plot title for example): r'$M = \left[ \frac{2}{\gamma - 1} \left( \frac{T_t}{T_s} - 1 \right) \r

[sphinx-dev] Embedding in redmine

2010-02-18 Thread David Huard
asset directory and set it as default, but the look is not that great. Thanks, David -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe from this group, send e

[sphinx-dev] Re: [Matplotlib-users] Baseline pngmath

2009-12-07 Thread David Arnold
Mike, Still did not work, as seen here: http://msemac.redwoods.edu/~darnold/html/cylinders.html The latex math is still occurring below the baseline. D. On Dec 7, 2009, at 11:49 AM, Michael Droettboom wrote: > David Arnold wrote: >> Hi, >> >> I set: >> >>

Re: [sphinx-dev] jsMath

2009-12-07 Thread David Arnold
le shows that things are not working. Here is the relevant source: **Exercise 1**. In this exercise we sketch the surface :math:`z=6-2x^2` on the domain :math:`\{(x,y):\,-2\le x, y\le 2\}`. D. On Dec 7, 2009, at 10:39 AM, Michael Droettboom wrote: > On Mon, Dec 7, 2009 at 1:06 PM, David

[sphinx-dev] jsMath

2009-12-07 Thread David Arnold
tic. When I do a "make html" I get this error: david-arnolds-macbook-pro-2:Homework darnold$ make html sphinx-build -b html -d _build/doctrees . _build/html Running Sphinx v0.6.3 loading pickled environment... done Exception occurred: File "/Library/Frameworks/Python.framework/Ve

[sphinx-dev] Baseline pngmath

2009-12-07 Thread David Arnold
All, I tried using sphinx.ext.pngmath. See: http://msemac.redwoods.edu/~darnold/html/cylinders.html Note in Exercise 1 how z = 6 - 2x^2 is placed so its baseline does not align (it's lower) with the baseline of the text. How can I align the baselines? David. -- You received this me

[sphinx-dev] Centering a figure in HTML

2009-12-05 Thread David Arnold
/html/intro_matplotlib.html Secondly, How can I number each of my figures with consecutive numbers? David -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe

[sphinx-dev] What elements do you extract to your web page

2009-12-05 Thread David
All, After working on a sphinx-project configured with sphinx-quickstart, what elements need to be uploaded to your web server? David. -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email

[sphinx-dev] MathML

2009-12-05 Thread David
All, Is there any support planned for MathML? Screen readers seem to be able to deal with MathML. David -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe

[sphinx-dev] jsmath_path

2009-12-05 Thread David
All, I put the jsMath folder in my _build directory then added: jsmath_path=['_static/jsMath/easy/load.js'] to my conf.py file. I am getting this error: david-arnolds-macbook-pro-2:sampledoc darnold$ make html sphinx-build -b html -d _build/doctrees . _build/html Running Sph

[sphinx-dev] Re: Django attribute documentation

2009-11-12 Thread David De Sousa
Hi! I managed to make sphinx's autoattribute to work with Django attributes, is there a way to collaborate? here's the diff between the original autodoc.py and my autodoc.py: (just in case, it's on http://pastebin.com/f6cece68e) 322c322,328 < obj = self.get_attr(obj, part) --- >

[sphinx-dev] Re: Chapter numbering in latex

2009-06-16 Thread David Huard
Thanks a lot ! David On Jun 15, 12:31 pm, Georg Brandl wrote: > Guenter Milde schrieb: > > > > > 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

[sphinx-dev] Chapter numbering in latex

2009-06-12 Thread David Huard
ue or there is a simple solution ? Many thanks, David The Sphinx version is from a pull I did today. --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send emai

Lists enumerated by letters or roman numerals

2009-04-21 Thread David C.
Hello everybody, I have a problem, the lists identified by letters or Roman numbers not working in "Sphinx v6.1" Is it a bug? or should I change something in conf.py? I would appreciate any help. Thank you. --~--~-~--~~~---~--~~ You received this message because y

Re: LaTeX customization

2009-03-30 Thread David Huard
ll require some time and experimentation and can lead to considerable frustration... Regards, David On Mar 30, 10:24 am, Dan Craig wrote: > +1 > > I plan on bringing sphinx into my company, but I need to be able to > make the printed documents look like company documents, whic

Re: Released: 0.6b1, 0.5.2b1

2009-03-19 Thread David Huard
Hi Georg, The autosummary directive does not seem to include the summary line in the second column. This is from a fresh hg pull. Cheers, David On Mar 16, 8:20 pm, Georg Brandl wrote: > Hi, > > I've just put beta versions of 0.6 and 0.5.2 on the cheeseshop. > Please test a

[bug-report] Error installing python30-doc in MacPorts: No module named jinja

2008-12-01 Thread David Briscoe
I am setting up my PPC G4 iBook (1.33GHz) after a recent format. Tiger 10.4.11. I was installing Python and wxpython. I installed Python2.6 and then since it doesn't have doc package, I tried Python3.0-doc (but didn't actually request Python3.0, just to see what would happen). ~$ uname -a Darwin