Re: [sphinx-dev] contextual help
On 25/10/2012 10:42, Renato wrote: Hi, in my project (java project) the user view the various "function" of project, by browser. The resposible of the project (to wich I have shown my works in Rest) told me, that we need a contextual html help. I mean: whereever hte user is browsing, the help button, must show, the correct help page. Is it possible? Is it possible to show a specific page,led by placeholder? Because, I can tell to programmer to set a variable that could be passed to retrive the right page, when the user push the help button Is it possible? I don't know but would be interested in this too for my wxPython based project. A little googling found these, maybe they are helpful. http://stackoverflow.com/questions/2690732/using-sphinx-to-create-context-sensitive-html-help Werner -- 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.
Re: [sphinx-dev] Re: Docutils 0.9
Hi Guenter, On 02/05/2012 21:17, Guenter Milde wrote: On 2012-05-02, Werner wrote: On 02/05/2012 10:26, Guenter Milde wrote: Dear Sphinxers, the Docutils team is going to release Docutils v. 0.9. Didn't see the PIL import issue mentioned, will this be fixed in this release? https://bitbucket.org/birkenfeld/sphinx/issue/757/again-accessinit-hash-collision-3-for-both I don't think so (but there are more bugfixes in v. 0.9 than mentioned in the last mail). If this is a Docutils issue, you might file a bug report to the Docutils bug tracker http://sourceforge.net/tracker/?group_id=38414&atid=422030 There is already one: http://sourceforge.net/tracker/?func=detail&aid=2993756&group_id=38414&atid=422030 It seems that "goodger" doesn't want to fix it and I am not technical enough to argue the point. Werner -- 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.
Re: [sphinx-dev] Docutils 0.9
On 02/05/2012 10:26, Guenter Milde wrote: Dear Sphinxers, the Docutils team is going to release Docutils v. 0.9. Didn't see the PIL import issue mentioned, will this be fixed in this release? https://bitbucket.org/birkenfeld/sphinx/issue/757/again-accessinit-hash-collision-3-for-both Werner -- 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.
Re: [sphinx-dev] Re: Links in source code snippets?
On 30/04/2012 22:19, TJA wrote: I would be interested in that as well. If it can't be done automatically: Is there a way to post-process the source-code manually to insert links (in my case, I know all functions and I could easily add the links myself.) :func:`foo` should do, see: http://sphinx.pocoo.org/markup/inline.html?highlight=reference Unless I misunderstand what you and Bryan like to get. Werner Am Montag, 27. Februar 2012 23:51:18 UTC+1 schrieb Bryan: All, Is there some way for hilighted source code to include hyperlinks to classes/variables/etc that have been documented? So that .. function:: foo() A function. :: foo() # Would be nice if foo() were hyperlinked in the resulting .html Bryan -- Bryan A. Jones, Ph.D. Associate Professor Department of Electrical and Computer Engineering 231 Simrall / PO Box 9571 Mississippi State University Mississippi state, MS 39762 http://www.ece.msstate.edu/~bjones <http://www.ece.msstate.edu/%7Ebjones> bjones AT ece DOT msstate DOT edu voice 662-325-3149 fax 662-325-2298 Our Master, Jesus Christ, is on his way. He'll show up right on time, his arrival guaranteed by the Blessed and Undisputed Ruler, High King, High God. - 1 Tim. 6:14b-15 (The Message) -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/KTZ7mxGSp8cJ. 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. -- 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.
Re: [sphinx-dev] Re: rdbms and sphnix
On 03/03/2012 14:55, Rita wrote: you are right. I got a bit further now. updating environment: 0 added, 1 changed, 0 removed Connecting to sqlite:///sampledata.db Running query u"select name as 'Name', email as 'E-mail' from users\norder by Name asc" Exception occurred: File "/usr/local/lib/python2.7/dist-packages/sphinxcontrib_sqltable-1.0-py2.7.egg/sphinxcontrib/sqltable.py", line 95, in run self.add_name(table_node) AttributeError: 'SQLTable' object has no attribute 'add_name' No idea on this one, maybe file an issue: https://bitbucket.org/birkenfeld/sphinx-contrib/issues Werner -- 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.
Re: [sphinx-dev] Re: rdbms and sphnix
Hi Rita, On 03/03/2012 14:32, Rita wrote: Ok. thanks ... .. sqltable:: :sqltable_connection_string: sqlite:///sampledata.db select name from users I think you need a blank line between the select and the :sqltable line Werner -- 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.
Re: [sphinx-dev] Re: rdbms and sphnix
On 03/03/2012 13:44, Rita wrote: Thanks for your response! Is there a more generic solution? what if i don't use sqlite Have not usee it but as it supports all SQLAlchemy supported db's you have quite a selection: http://sqlalchemy.readthedocs.org/en/latest/core/engines.html Werner On Sat, Mar 3, 2012 at 7:29 AM, togakushi <mailto:nina.togaku...@gmail.com>> wrote: Hi, Try this http://www.doughellmann.com/docs/sphinxcontrib-sqltable/index.html -- 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 <mailto:sphinx-dev@googlegroups.com>. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com <mailto:sphinx-dev%2bunsubscr...@googlegroups.com>. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. -- --- Get your facts first, then you can distort them as you please.-- -- 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. -- 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.
Re: [sphinx-dev] Sphinx inheritance-diagram Issue
On 12/12/2011 12:06 PM, sajuptpm wrote: I created complete API documentation using sphinx. Command i used are: $ sphinx-apidoc -f -F -o . /home/sam/CMS $ make html Then i planned to add inheritance-diagram of classes, for that i edited "provider.rst" file and added two new lines as shown below. provider diagram .. inheritance-diagram:: CMS.cloud.DbModel.CloudProvider I am no Sphinx expert, but I try anyhow. - did you add "sphinx.ext.inheritance_diagram" to your conf.py - extensions - did you install graphviz - see also at the end of: http://sphinx.pocoo.org/ext/graphviz.html#module-sphinx.ext.graphviz Werner -- 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.
Re: [sphinx-dev] Module index page
On 12/09/2011 01:11 PM, werner wrote: The Sphinx modules index page (http://sphinx.pocoo.org/py-modindex.html) shows entries not ordered under "sphinx" (top level) but ordered by the next level down. I.e. "sphinx.ext" is shown under the letter "e", how is this done. I searched the doc but can't find it, can anyone please give me a hint on how to do this. Never mind, just found it. Adjusting the entry "modindex_common_prefix" in conf.py does the trick. Werner -- 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] Module index page
The Sphinx modules index page (http://sphinx.pocoo.org/py-modindex.html) shows entries not ordered under "sphinx" (top level) but ordered by the next level down. I.e. "sphinx.ext" is shown under the letter "e", how is this done. I searched the doc but can't find it, can anyone please give me a hint on how to do this. Werner -- 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.
Re: [sphinx-dev] Help for translation
Wouldn't the gettext based translation in Sphinx 1.1 work for this? http://sphinx.pocoo.org/intl.html Never used it but I would think that is its purpose, no? Werner -- 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.
Re: [sphinx-dev] Nice and consistent graphs
On 09/26/2011 12:27 PM, Andrea Crotti wrote: I just saw today the nice sphinx.ext.graphviz extension, and I think I will use it heavily. The only problem is that I wanted to get all the graphs with a nice-looking and consistent style, and graphviz for that doesn't really help. If for example all the nodes should be black I should write node [color=black] in every dot snippet of code. One possible solution is to use pygraphviz and make the whole thing more "object-oriented", are there other solutions using sphinx-only? not an expert on all this but couldn't you use conf.py? I use them for inheritance graphs and do this which I was pointed to do by someone on the list. # draw them top to bottom inheritance_graph_attrs = dict(rankdir="TB", size='"10.0, 10.0"') inheritance_node_attrs = dict(style='filled') Werner -- 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.
Re: [sphinx-dev] Is it possible to customise the mapping from ReST headings to HTML headings?
On 10/04/2011 03:30, Tim Martin wrote: ... The problem I hit here is that the largest heading type in ReST is automatically mapped to, whatever I do. This means that 'Section 1' always comes out as, but I need it to be in order to fit with the style. Is there some way to control the way that ReST headings are mapped to HTML? sections subsection -- subsub ^^ First maps to H1, second to H2 and third to H3. http://sphinx.pocoo.org/rest.html#sections Werner -- 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] How to tell Sphinx not to copy ".svn" folders within a subfolder of _static
I tried this in the conf.py but the folders are still copied to e.g. html/build/_static/macWidgets: exclude_patterns = ['_static/macWidgets/.svn', '_static/winWidgets/.svn', '_static/nixWidgets/.svn', '**/.svn'] I am on Windows 7 with Sphinx 1.0.7 Werner -- 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] generator already executing - exception
I am running into the same problem with 1.0.7 which had been reported by Andrea for 1.0.3 sometimes last August. Has anyone found a solution for this? Werner -- 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 version: 1.0.7 # Python version: 2.6.5 # Docutils version: 0.7 release # Jinja2 version: 2.5.2 Traceback (most recent call last): File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\cmdline.py", line 188, in main app.build(force_all, filenames) File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\application.py", line 210, in build raise File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\application.py", line 207, in build self.builder.build_update() File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\builders\__init__.py", line 198, in build_update 'out of date' % len(to_build)) File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\builders\__init__.py", line 254, in build self.write(docnames, list(updated_docnames), method) File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\builders\__init__.py", line 294, in write self.write_doc(docname, doctree) File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\builders\html.py", line 415, in write_doc self.handle_page(docname, ctx, event_arg=doctree) File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\builders\html.py", line 706, in handle_page output = self.templates.render(templatename, ctx) File "c:\python26\lib\site-packages\sphinx-1.0.7-py2.6.egg\sphinx\jinja2glue.py", line 118, in render return self.environment.get_template(template).render(context) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\environment.py", line 716, in get_template return self._load_template(name, self.make_globals(globals)) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\environment.py", line 690, in _load_template template = self.loader.load(self, name, globals) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\loaders.py", line 127, in load code = environment.compile(source, name, filename) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\environment.py", line 478, in compile source = self._parse(source, name, filename) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\environment.py", line 397, in _parse return Parser(self, source, name, _encode_filename(filename)).parse() File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\parser.py", line 32, in __init__ self.stream = environment._tokenize(source, name, filename, state) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\environment.py", line 429, in _tokenize stream = self.lexer.tokenize(source, name, filename, state) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\lexer.py", line 501, in tokenize return TokenStream(self.wrap(stream, name, filename), name, filename) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\lexer.py", line 298, in __init__ next(self) File "c:\python26\lib\site-packages\jinja2-2.5.2-py2.6.egg\jinja2\lexer.py", line 343, in next self.current = self._next() ValueError: generator already executing
Re: [sphinx-dev] Where's the documentation for :source: ?
Ram, On 17/03/2011 01:53, cool-RR wrote: Hello, I see that the new Python docs are able to link to source files in the Python hg repo, like in here: http://docs.python.org/dev/library/abc.html This is very cool. I see that this is done with the :source: role, but I was unable to find the docs for it. Where are they? I believe it uses this extension. http://sphinx.pocoo.org/ext/viewcode.html?highlight=configuration Werner -- 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.
Re: [sphinx-dev] Re: undefined label problem
Günter, On 05/03/2011 20:38, Guenter Milde wrote: On 2011-03-04, werner wrote: I get this error: C:\dev\dabodoc\api\sphinx\source\dabo.biz.RemoteBizobj.RemoteBizobj.rst:631: WARNING: undefined label: no-612-dabo.biz.remotebizobj.remotebizobj.setlimit (if the link has no caption the label must precede a section header) The label definition is this: .. _no-612-dabo.biz.RemoteBizobj.RemoteBizobj.setLimit: no-612-dabo.biz.RemoteBizobj.RemoteBizobj.setLimit If you want a visible label, you can just write _`label1` If you want a hidden label, write .. _label2: separated by blank lines above and below. Now I link to label1_ and label2_. A construct like .. _label3: label3 leads to a warning: Explicit markup ends without a blank line; unexpected unindent. here. Linking to label3_ works, though. It was the blank lines I "fell over", i.e. didn't have in all cases. Thanks for the detailed explanation. Werner -- 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] undefined label problem
I get this error: C:\dev\dabodoc\api\sphinx\source\dabo.biz.RemoteBizobj.RemoteBizobj.rst:631: WARNING: undefined label: no-612-dabo.biz.remotebizobj.remotebizobj.setlimit (if the link has no caption the label must precede a section header) The label definition is this: .. _no-612-dabo.biz.RemoteBizobj.RemoteBizobj.setLimit: no-612-dabo.biz.RemoteBizobj.RemoteBizobj.setLimit .. function:: dabo.biz.RemoteBizobj.RemoteBizobj.setLimit(self, clause) :noindex: I need to use "noindex" on the above as this function is inherited from another class and that class is used in multiple places, so was hoping that defining the label manually as shown above and I prefix it with a unique number, just to be sure not to get any duplicates. And I use it like this: | :ref:`setLimit ` Explicitly set the limit clause. Replaces any existing limit settings. Where am I going wrong? Werner -- 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.
Re: [sphinx-dev] Re: undefined label warning with incorrect line numbers
On 01/03/2011 08:17, Guenter Milde wrote: On 2011-02-28, werner wrote: On 28/02/2011 10:44, Guenter Milde wrote: On 2011-02-26, werner wrote: On 26/02/2011 22:25, Guenter Milde wrote: ... This is with Sphinx 1.0.7 on Windows 7 and Python 2.6.5 There has been work on a similar problem with the Docutils parser (used by Sphinx). What is the Docutils version? 0.7 This is up-to-date, so it seems to point to a still existing system. Could you try to provide a minimal standalone rst source that shows the problem with Docutils (rst2html.py, say)? I get this with rst2html: C:\dev\aaTests\sphinxTest\source>\python26\python C:\Python26\Lib\site-packages\rst2html.py index.rst index.html index.rst:149: (ERROR/3) Unknown interpreted text role "ref". index.rst:150: (ERROR/3) Unknown interpreted text role "ref". ... Yes, the :ref: role is a Sphinx extension, so if the line numbers are correct, this is intended behaviour. Where as with Sphinx on the same files I get: C:\dev\aaTests\sphinxTest\source\index.rst:278: WARNING: undefined label: dabo.dapp (if the link has no caption the label must precede a section header) C:\dev\aaTests\sphinxTest\source\index.rst:279: WARNING: undefined label: dabo.dobject (if the link has no caption the label must precede a section header) ... It seems like the fix for line-numbers with/after included files was not ported to the Sphinx extensions to Docutils. I suggest to report this bug to the Sphinx bug tracker. Günter Done #648 Werner -- 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.
Re: [sphinx-dev] Re: undefined label warning with incorrect line numbers
On 28/02/2011 10:44, Guenter Milde wrote: On 2011-02-26, werner wrote: On 26/02/2011 22:25, Guenter Milde wrote: ... This is with Sphinx 1.0.7 on Windows 7 and Python 2.6.5 There has been work on a similar problem with the Docutils parser (used by Sphinx). What is the Docutils version? 0.7 This is up-to-date, so it seems to point to a still existing system. Could you try to provide a minimal standalone rst source that shows the problem with Docutils (rst2html.py, say)? I get this with rst2html: C:\dev\aaTests\sphinxTest\source>\python26\python C:\Python26\Lib\site-packages\rst2html.py index.rst index.html index.rst:149: (ERROR/3) Unknown interpreted text role "ref". index.rst:150: (ERROR/3) Unknown interpreted text role "ref". index.rst:151: (ERROR/3) Unknown interpreted text role "ref". index.rst:152: (ERROR/3) Unknown interpreted text role "ref". index.rst:153: (ERROR/3) Unknown interpreted text role "ref". index.rst:149: (ERROR/3) Unknown interpreted text role "ref". index.rst:150: (ERROR/3) Unknown interpreted text role "ref". Where as with Sphinx on the same files I get: C:\dev\aaTests\sphinxTest\source\index.rst:278: WARNING: undefined label: dabo.dapp (if the link has no caption the label must precede a section header) C:\dev\aaTests\sphinxTest\source\index.rst:279: WARNING: undefined label: dabo.dobject (if the link has no caption the label must precede a section header) C:\dev\aaTests\sphinxTest\source\index.rst:280: WARNING: undefined label: dabo.dreportwriter (if the link has no caption the label must precede a section header) C:\dev\aaTests\sphinxTest\source\index.rst:281: WARNING: undefined label: dabo.dsecuritymanager (if the link has no caption the label must precede a section header) C:\dev\aaTests\sphinxTest\source\index.rst:282: WARNING: undefined label: dabo.dusersettingprovider (if the link has no caption the label must precede a section header) I can provide you a small ZIP (230kb) with the .rst etc I used for this, if that would help. Werner -- 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.
Re: [sphinx-dev] Re: undefined label warning with incorrect line numbers
On 26/02/2011 22:25, Guenter Milde wrote: ... This is with Sphinx 1.0.7 on Windows 7 and Python 2.6.5 There has been work on a similar problem with the Docutils parser (used by Sphinx). What is the Docutils version? 0.7 Werner -- 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] intersphinx - trying to link
Trying to link e.g. to this:
http://xoomer.virgilio.it/infinity77/AGW_Docs/foldpanelbar.FoldPanelItem.html#foldpanelbar.FoldPanelItem
my conf.py has:
intersphinx_mapping = {"python": ('http://docs.python.org/', None),
"agw":
('http://xoomer.virgilio.it/infinity77/AGW_Docs/', None),
}
And Sphinx build can read both the Python and the agw objects.inv file.
Then I have a link in the doc like this:
:ref:``
But I get a warning "undefined label)
Trying to figure out if I use the correct label I looked at objects.inv
and I think this is the relevant entry in there:
(u'Advanced Generic Widgets', u'0.9.1',
u'http://xoomer.virgilio.it/infinity77/AGW_Docs/foldpanelbar.FoldPanelItem.html#foldpanelbar-foldpanelitem',
u'FoldPanelItem')
Can someone help me figure out where I am going wrong with this?
Werner
--
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] undefined label warning with incorrect line numbers
I am getting warnings like this: C:\dev\dabo\doc\source\dabo.dObject.dObject.rst:157: WARNING: undefined label: dabo.lib.autosuper.autosuper.autosuper (if the link has no caption the label must precede a section header) C:\dev\dabo\doc\source\dabo.dObject.dObject.rst:181: WARNING: undefined label: dabo.ui.dfont.dfont (if the link has no caption the label must precede a section header) In this particular case they are all off by 129, i.e. 157 should be 28 etc. Noticed in the release notes for 1.0.6 that should be fixed, do I need to upgrade something? Werner This is with Sphinx 1.0.7 on Windows 7 and Python 2.6.5 -- 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.
Re: [sphinx-dev] autodocumenting warning with 1.0.7
On 21/02/2011 15:27, werner wrote: Just upgraded to 1.0.7 and I get lots of these: source/headings.txt:4: (WARNING/2) don't know which module to import for autodocumenting u'__init__' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) My first 7 lines in headings.txt are: .. |doc_title| image:: _static/doc_title.png :align: top :width: 32 .. |description| image:: _static/Description.png :align: top :width: 32 The above is then used in the .rst like this: .. include:: headings.txt .. module:: dabo.biz.dAutoBizobj .. _dabo.biz.dAutoBizobj.dAutoBizobj: |doc_title| **dAutoBizobj.dAutoBizobj** - class Anyone has an idea why this would cause a problem in 1.0.7 but not in 1.0.4? I think these errors where caused by the following type of code: .. autoclass:: dabo.dObject.dObject .. automethod:: __init__ If I change it to: .. autoclass:: dabo.dObject.dObject .. automethod:: dabo.dObject.dObject.__init__ the errors go away. Shouldn't either of them work? Werner -- 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.
Re: [sphinx-dev] Beginner's Guide?
On 21/02/2011 16:44, TP wrote: For one example of how to document a Python method see http://tpgit.github.com/MDIImageViewer/imageviewer.html#imageviewer.ImageViewer.scaleImage. Click on the [source] link on the right to see the actual Python method (along with its docstring that generated the documentation). What causes the Inheritance diagram to go top/down instead of right/left? Is this some conf.py setting or ...? I am working on documenting Dabo with Sphinx and if you look at this page you can see my problem with the inheritance diagram. http://thewinecellarbook.com/daboDocTest/dabo.ui.dButton.dButton.html Werner -- 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] autodocumenting warning with 1.0.7
Just upgraded to 1.0.7 and I get lots of these: source/headings.txt:4: (WARNING/2) don't know which module to import for autodocumenting u'__init__' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name) My first 7 lines in headings.txt are: .. |doc_title| image:: _static/doc_title.png :align: top :width: 32 .. |description| image:: _static/Description.png :align: top :width: 32 The above is then used in the .rst like this: .. include:: headings.txt .. module:: dabo.biz.dAutoBizobj .. _dabo.biz.dAutoBizobj.dAutoBizobj: |doc_title| **dAutoBizobj.dAutoBizobj** - class Anyone has an idea why this would cause a problem in 1.0.7 but not in 1.0.4? Werner -- 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.
Re: [sphinx-dev] Beginner's Guide?
Hi, I am pretty new to this too, so take my advice with a grain of salt. On 18/02/2011 14:00, Burhan wrote: Hello: I am new to Sphinx, and am going to use it for a python project to generate HTML documentation. My problem is rather basic, I'm not sure how to format my docstrings so that Sphinx can extract the information. I understand about using autodoc extension, and making sure that my modules are available to python so that sphinx can find my code - my problem is a bit basic, how do I actually comment the code? Do I have to enter *verbatim* examples are written in the documentation? So for example, is it like this: def my_funct(param=None,param2=None): """ .. py:func:: my_funct(param=None,param2=None) This function does something with two parameters, which are default to :py:`None` """ Or do I have to document it separately in another file? A simple python code example would really help me out. In your code you would do this: def my_funct(param=None,param2=None): """ This function does something with two parameters, which are default to :py:`None` """ and in the .rst file you could do: .. autoclass:: :members: for other ways/options see http://sphinx.pocoo.org/domains.html to generate the .rst files (if you don't want to do them by hand or at least to get a start) you might want to look at https://bitbucket.org/etienned/sphinx-autopackage-script Werner -- 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.
Re: [sphinx-dev] Re: Tab spacing of code
On 17/02/2011 15:13, Guenter Milde wrote: On 2011-02-16, werner wrote: Docutils has a generic 'tab-width' configuration options, but I don't know how this is set in Sphinx. This has been discussed before: http://groups.google.com/group/sphinx-dev/browse_thread/thread/35b8071ffe9a8feb Thanks for this link. I had found it too after some more searching. Still didn't find a way to set this in Sphinx, so I use some code to convert the tabs in the .rst files before feeding them to Sphinx, not ideal, but nicer. Maybe you can file a bug/enhancement report. Done #642 Werner -- 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] Traceback instead of nice error
Having this in my .rst:
.. function:: applyDiffAndSave(self, diff, primary=False)
Diffs are dicts in the format:
or
.. function:: applyDiffAndSave(self, diff, primary=False) Diffs are
dicts in the format:
Causes the following traceback.
Adding the blank line as follows corrects this, but it would be nice if
Sphinx is just logging an error as it does for other formatting problems.
.. function:: applyDiffAndSave(self, diff, primary=False)
Diffs are dicts in the format:
# Sphinx version: 1.0.4
# Docutils version: 0.7 release
# Jinja2 version: 2.5.2
Traceback (most recent call last):
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\cmdline.py", line
173, in main
app.build(force_all, filenames)
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\application.py",
line 203, in build
self.builder.build_all()
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\builders\__init__.py",
line 161, in build_all
self.build(None, summary='all source files', method='all')
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\builders\__init__.py",
line 218, in build
purple, length):
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\builders\__init__.py",
line 120, in status_iterator
for item in iterable:
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\environment.py",
line 515, in update_generator
self.read_doc(docname, app=app)
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\environment.py",
line 676, in read_doc
app.emit('doctree-read', doctree)
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\application.py",
line 311, in emit
results.append(callback(self, *args))
File
"c:\python26\lib\site-packages\sphinx-1.0.4-py2.6.egg\sphinx\ext\viewcode.py",
line 55, in doctree_read
modname = signode['module']
File
"c:\python26\lib\site-packages\docutils-0.7-py2.6.egg\docutils\nodes.py", line
534, in __getitem__
return self.attributes[key]
KeyError: 'module'
Werner
--
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.
Re: [sphinx-dev] Parameter etc formating
On 16/02/2011 21:21, werner wrote: I have this in my .rst file: Add SQL JOIN clause. :param tbl: the name of the table to join with :param exp: the join expression :param joinType: examples: "LEFT", "RIGHT", "INNER", "OUTER" which is rendered in html like: Add SQL JOIN clause. param tbl: the name of the table to join with param exp: the join expression param joinType: examples: "LEFT", "RIGHT", "INNER", "OUTER" I have seen in other Sphinx doc a rendering like this: Parameters: * *parent* -- the AuiNotebook <http://xoomer.virgilio.it/infinity77/AGW_Docs/aui.auibook.AuiNotebook.html#aui.auibook.AuiNotebook> parent; * *id* -- an identifier for the control: a value of -1 is taken to mean a default; * *pos* -- the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform; I can't find how I can change this, i.e. instead of repeating "param" to have a header "Parameters". Looking at the html with Firebug I see that both use a table class "docutils field-list, but the "child" elements are different in mine to the other doc I look at. Can someone give me a tip on how to influence this. Found an older thread on this which states that this only works for/with "..function::" and the list has to be a direct child of it. Is this still the case or can one get it to work in some other way? Werner -- 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] Parameter etc formating
I have this in my .rst file: Add SQL JOIN clause. :param tbl: the name of the table to join with :param exp: the join expression :param joinType: examples: "LEFT", "RIGHT", "INNER", "OUTER" which is rendered in html like: Add SQL JOIN clause. param tbl: the name of the table to join with param exp: the join expression param joinType: examples: "LEFT", "RIGHT", "INNER", "OUTER" I have seen in other Sphinx doc a rendering like this: Parameters: * *parent* -- the AuiNotebook <http://xoomer.virgilio.it/infinity77/AGW_Docs/aui.auibook.AuiNotebook.html#aui.auibook.AuiNotebook> parent; * *id* -- an identifier for the control: a value of -1 is taken to mean a default; * *pos* -- the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform; I can't find how I can change this, i.e. instead of repeating "param" to have a header "Parameters". Looking at the html with Firebug I see that both use a table class "docutils field-list, but the "child" elements are different in mine to the other doc I look at. Can someone give me a tip on how to influence this. Werner -- 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.
Re: [sphinx-dev] Re: Tab spacing of code
Guenter, On 16/02/2011 09:51, Guenter Milde wrote: On 2011-02-15, werner wrote: It looks as if the "tabs" get double expanded, The default is TAB -> 8 spaces. is there some setting for this? Could only find "tab-width" for literalinclude. The per-file tab-width option is also available for "include". Docutils has a generic 'tab-width' configuration options, but I don't know how this is set in Sphinx. This has been discussed before: http://groups.google.com/group/sphinx-dev/browse_thread/thread/35b8071ffe9a8feb Thanks for this link. I had found it too after some more searching. Still didn't find a way to set this in Sphinx, so I use some code to convert the tabs in the .rst files before feeding them to Sphinx, not ideal, but nicer. Werner -- 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] Tab spacing of code
Example:: class MyButton(dabo.ui.dButton): def initProperties(self): self.Caption = "Press Me" def onHit(self, evt): self.Caption = "Press Me one more time" Gives me: Example: class MyButton(dabo.ui.dButton): def initProperties(self): self.Caption = "Press Me" def onHit(self, evt): self.Caption = "Press Me one more time" It looks as if the "tabs" get double expanded, is there some setting for this? Could only find "tab-width" for literalinclude. Werner -- 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] show inheritance on members
When using this: .. autoclass:: Foo :members: :show-inheritance: :inherited-members: Is it possible to show/mark in some way the members which are inherited, similar to: Bases: dabo.ui.uiwx.dMenuBar.dMenuBar maybe: Inherited from: . or maybe group them, first the "own" members and then the inherited once. Werner P.S. Sphinx 1.0.4 -- 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.
Re: [sphinx-dev] Problem with documenting super classes - resolved
On 06/02/2011 17:20, werner wrote: ... .. include:: headings.txt .. module:: dabo.lib.eventMixin .. currentmodule:: eventMixin .. _lib.eventMixin.EventMixin: === |doc_title| **EventMixin** === |API| Class API === .. autoclass:: EventMixin :members: Using the above works if I remove the line ".. currentmodule", don't understand why this causes the problem but that is less of a problem:-) . Werner -- 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.
Re: [sphinx-dev] Problem with documenting super classes
It is something to do with sys.path but I don't get it. I moved my non-working .rst into the folder with my working .rst (which use automodule) and deleted the build/html folder and did a make html. The file which contains this works: The :mod:`eventMixin` Module .. automodule:: dabo.lib.eventMixin :members: :undoc-members: :show-inheritance: | Inheritance Diagram === Inheritance diagram for: **lib.eventMixin** .. inheritance-diagram:: dabo.lib.eventMixin And the one with the following does not work - i.e. I see errors in the log file that class could not be imported (which I finally found after using -w sphinxerr.txt option). .. include:: headings.txt .. module:: dabo.lib.eventMixin .. currentmodule:: eventMixin .. _lib.eventMixin.EventMixin: === |doc_title| **EventMixin** === |API| Class API === .. autoclass:: EventMixin :members: The error log states "C:\dev\dabo\sphinx-autopackage-script\doc-sphinx2\source\dabo.lib.eventMixin.EventMixin.rst:59: (WARNING/2) autodoc can't import/find class 'eventMixin.EventMixin', it reported error: "No module named eventMixin", please check your spelling and sys.path" Should it not state "class 'dabo.lib.eventMixin.EventMixin' .? Now both are built in the same folder using the same conf.py, so it can't really be my sys.path setting in the real folder. BTW, the framework does seem to do quit a bit of namespace mangling, but it still doesn't explain why the automodule approach works and the module/autoclass does not work. Werner P.S. I am back on Sphinx 1.0.4 on Python 2.6 on Windows -- 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.
Re: [sphinx-dev] Problem with documenting super classes
On 31/01/2011 18:03, werner wrote: On 30/01/2011 11:07, werner wrote: On 29/01/2011 13:43, werner wrote: I am having my first go at trying to document an application with Sphinx, the application is a framework I try to learn which has no searchable documentation, so I thought I might as well learn how to document it with Sphinx. I am running into a problem that super classes contained in top level .py files (the ones at the package folder) don't get linked correctly. For example: foo.py contains class foo and foo.py is in package x In the code some other class inherits from class foo by doing from x.foo import foo class anotherClass(foo): Now when documenting anotherClass I get for the super class "x.foo.foo" but when documenting foo I get "foo.foo" i.e. without the top level package. I hope I am explaining this well enough. I guess I need to somehow tell Sphinx that class x.foo.foo is documented as class foo.foo to make sure that e.g. Inheritance diagrams can link to the correct class documentation etc. Can someone give me some hints on what I need to do. Werner Made a bit of progress but can't quit figure it out, added a :module:: for each class helped, but caused other links not to work. Maybe an image might explain this all much better. Anything prefixed with "dabo." is not clickable in the following diagram, and the definition for e.g. dabo.dObject.dObject is: Inheritance diagram for: *dApp* Inheritance diagram of dApp I tried to isolate where the problem is. If I use "automodule" for all the package, along this way. The :mod:`dApp` Module -- .. automodule:: dabo.dApp :members: :undoc-members: :show-inheritance: Inheritance Diagram === Inheritance diagram for: **dApp** .. inheritance-diagram:: dApp The diagram works perfectly, but with the following it doesn't work, correctly, i.e. only the "dApp.something" links work, but not the ones starting e.g. with "dabo.lib": .. include:: headings.txt .. module:: dabo.dApp .. currentmodule:: dApp = |doc_title| **dApp** = Inheritance diagram for: **dApp** .. inheritance-diagram:: dApp I must be doing something wrong when using module/currentmodule instead of automodule, but I can just not figure it out. Any points would be very welcome Werner -- 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. <>
Re: [sphinx-dev] Problem with documenting super classes
On 30/01/2011 11:07, werner wrote: On 29/01/2011 13:43, werner wrote: I am having my first go at trying to document an application with Sphinx, the application is a framework I try to learn which has no searchable documentation, so I thought I might as well learn how to document it with Sphinx. I am running into a problem that super classes contained in top level .py files (the ones at the package folder) don't get linked correctly. For example: foo.py contains class foo and foo.py is in package x In the code some other class inherits from class foo by doing from x.foo import foo class anotherClass(foo): Now when documenting anotherClass I get for the super class "x.foo.foo" but when documenting foo I get "foo.foo" i.e. without the top level package. I hope I am explaining this well enough. I guess I need to somehow tell Sphinx that class x.foo.foo is documented as class foo.foo to make sure that e.g. Inheritance diagrams can link to the correct class documentation etc. Can someone give me some hints on what I need to do. Werner Made a bit of progress but can't quit figure it out, added a :module:: for each class helped, but caused other links not to work. Maybe an image might explain this all much better. Anything prefixed with "dabo." is not clickable in the following diagram, and the definition for e.g. dabo.dObject.dObject is: Inheritance diagram for: *dApp* Inheritance diagram of dApp Then re-read the currentmodule/module stuff again and changed e.g. dabo.dObject.dObject which was not linked (i.e. not clickable) to this: .. module:: dabo.dObject .. currentmodule:: dObject I.e. added "dabo." to the module definition. Great now it is linked, BUT, now all the others which worked before e.g. dApp.dApp and dApp.TempFileHolder etc are no longer linked. The .rst files are generated and not hand coded, and the base (super) classes are queried with "sups = list(obj.__bases__)" and they sometimes have the "dabo." package name prefixed and sometimes not, I think it depends on the way one does the import. Any tip on how I can have both everything linked? Werner P.S. Python 2.6.5 Sphinx 1.0.4 P.S. 2 I also tried: .. module:: dabo.dObject .. currentmodule:: dabo.dObject I can't make it work that both "dabo.dObject.dObject" and "dObject.dObject" links in e.g. Inheritance diagrams work. The package structure is: dabo - biz - lib etc all the modules in the dabo package I define it like this: .. module:: dObject .. currentmodule:: dObject Anything in sub-packages, e.g. biz is defined like this: .. module:: dabo.biz.RemoteBizobj .. currentmodule:: biz.RemoteBizobj Is above correct? Or is this problem caused by something else I am doing? Werner -- 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. <>
Re: [sphinx-dev] Problem with documenting super classes
On 29/01/2011 13:43, werner wrote: I am having my first go at trying to document an application with Sphinx, the application is a framework I try to learn which has no searchable documentation, so I thought I might as well learn how to document it with Sphinx. I am running into a problem that super classes contained in top level .py files (the ones at the package folder) don't get linked correctly. For example: foo.py contains class foo and foo.py is in package x In the code some other class inherits from class foo by doing from x.foo import foo class anotherClass(foo): Now when documenting anotherClass I get for the super class "x.foo.foo" but when documenting foo I get "foo.foo" i.e. without the top level package. I hope I am explaining this well enough. I guess I need to somehow tell Sphinx that class x.foo.foo is documented as class foo.foo to make sure that e.g. Inheritance diagrams can link to the correct class documentation etc. Can someone give me some hints on what I need to do. Werner Made a bit of progress but can't quit figure it out, added a :module:: for each class helped, but caused other links not to work. Maybe an image might explain this all much better. Anything prefixed with "dabo." is not clickable in the following diagram, and the definition for e.g. dabo.dObject.dObject is: Inheritance diagram for: *dApp* Inheritance diagram of dApp Then re-read the currentmodule/module stuff again and changed e.g. dabo.dObject.dObject which was not linked (i.e. not clickable) to this: .. module:: dabo.dObject .. currentmodule:: dObject I.e. added "dabo." to the module definition. Great now it is linked, BUT, now all the others which worked before e.g. dApp.dApp and dApp.TempFileHolder etc are no longer linked. The .rst files are generated and not hand coded, and the base (super) classes are queried with "sups = list(obj.__bases__)" and they sometimes have the "dabo." package name prefixed and sometimes not, I think it depends on the way one does the import. Any tip on how I can have both everything linked? Werner P.S. Python 2.6.5 Sphinx 1.0.4 P.S. 2 I also tried: .. module:: dabo.dObject .. currentmodule:: dabo.dObject -- 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] Problem with documenting super classes
I am having my first go at trying to document an application with Sphinx, the application is a framework I try to learn which has no searchable documentation, so I thought I might as well learn how to document it with Sphinx. I am running into a problem that super classes contained in top level .py files (the ones at the package folder) don't get linked correctly. For example: foo.py contains class foo and foo.py is in package x In the code some other class inherits from class foo by doing from x.foo import foo class anotherClass(foo): Now when documenting anotherClass I get for the super class "x.foo.foo" but when documenting foo I get "foo.foo" i.e. without the top level package. I hope I am explaining this well enough. I guess I need to somehow tell Sphinx that class x.foo.foo is documented as class foo.foo to make sure that e.g. Inheritance diagrams can link to the correct class documentation etc. Can someone give me some hints on what I need to do. Werner -- 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.
Re: [sphinx-dev] Rst2pdf version 0.16 is out!
On 07/10/2010 13:34, Roberto Alsina wrote: On Thursday 07 October 2010 08:25:14 werner wrote: On 06/10/2010 23:46, Roberto Alsina wrote: Finally, a new release of rst2pdf! You can get it at its site: http://rst2pdf.googlecode.com I did a SVN update and setup.py install, after that I see this: Exception occurred: File "C:\Python26\lib\site-packages\rst2pdf-0.16.dev_r2392-py2.6.egg\rst2pdf\sty les.py", line 28, in from rst2pdf.rson import loads as rson_loads File "C:\Python26\lib\site-packages\rst2pdf-0.16.dev_r2392-py2.6.egg\rst2pdf\rso n.py", line 270 def __getattr__(self, key): ^ Fixed in r2398, it was a typo in trunk, the 0.16 release doesn't have it. You are just too fast! Thanks Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Rst2pdf version 0.16 is out!
On 06/10/2010 23:46, Roberto Alsina wrote:
Finally, a new release of rst2pdf!
You can get it at its site: http://rst2pdf.googlecode.com
I did a SVN update and setup.py install, after that I see this:
Exception occurred:
File
"C:\Python26\lib\site-packages\rst2pdf-0.16.dev_r2392-py2.6.egg\rst2pdf\styles.py",
line 28, in
from rst2pdf.rson import loads as rson_loads
File
"C:\Python26\lib\site-packages\rst2pdf-0.16.dev_r2392-py2.6.egg\rst2pdf\rson.py",
line 270
def __getattr__(self, key):
^
Werner
--
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+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Done fixes for sphinx 1.0.x
Hi Roberto, On 04/10/2010 00:53, Roberto Alsina wrote: Thanks to the generosity of a rst2pdf/sphinx user, I have been sponsored to fix several problems related to rst2pdf and sphinx 1.0.x Thank you to both the sponsors and to you for the work. Specifically: 1) Some index entries were missing before, and now they are added 2) There was a bug in the "there is a link to some missing anchor" handling. It could make your sphinx doc do 10*4*broken_link_count passes. Just so you see how much that is: I saw a doc make over 300 passes before finishing. Now it does 3, and takes roughly 2 hours less time to build ;-) 3) Implemented domain-specific indices, which replaces the old modindex from sphinx 0.6.x (rst2pdf Issue 318) and it seems to be up to par. 4) Some index entries were generated with invalid anchor names, so they were dangling So, if anyone had used rst2pdf with sphinx 1.0.x but it didn't work before... now is a good time to try again with rst2pdf from SVN trunk! It needs testing, but it should work better than before. If there is enough confirmation that it works better, I will make a release ASAP. I am using these versions - did I get the correct ref for rst2pdf (just did an SVN update, so I assume yes)? Just did it on my stuff and have following findings. - For each page in the document I get these type of warnings four times: [ERROR] createpdf.py:1105 Page 119 [133] [ERROR] createpdf.py:1105 Page 120 [134] [ERROR] createpdf.py:1105 Page 121 [135] [ERROR] createpdf.py:1105 Page 122 [136] - the date formating on the cover page is not fixed (e.g. German locale) The PDF document is build and looks correct with the exception of the date mentioned above. Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] rst2pdf and 1.0.3 Sphinx issues, was - Finally got around to upgrade to 1.x
Hi Roberto, That was ultra fast! :-) On 15/09/2010 15:46, Roberto Alsina wrote: ... - I get a warning " Using undefined style 'kbd', aliased to style 'normal'.", but I can't find where style "kbd" is referenced Probably sphinx is assigning class kbd to some element, and it's not in rst2pdf's stylesheet. Usually that's harmless unless of course it looks ugly, in which case a style needs to be added to the stylesheet :-) Hhm, maybe this? ":kbd:`Alt-s` ", I am pretty sure this worked/showed nicely before. I think it was «Alt-s», but I am not sure. stylesheet stuff is still black magic to me, can you give me some hints. I assume it should go into "sphinx.styles" but have no idea what I need to add to this. - on the cover page the date is shown a strangely, i.e. "day" is in bold and uses a larger font then the rest, i.e. "month" and "year" are about 2/3 of a line down and over to the right by a few spaces. That's weird. I'll take a look tonight. Just realized that it is fine in my "english" doc but not in my "german" version. English: German: Aha, an issue with the date format, i.e. I guess Sphinx is switching it to German locale format as the language in conf.py is defined as "de" and then the above tries to translate 15 to the month name. Do I need to set something special for this in the conf.py rst2pdf section? Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en. <><>
Re: [sphinx-dev] rst2pdf and 1.0.3 Sphinx issues, was - Finally got around to upgrade to 1.x
Hi Roberto, On 14/09/2010 15:55, Roberto Alsina wrote: On Sunday 12 September 2010 05:47:20 werner wrote: I looked through the changes for 0.6.5 to 1.0.3 but don't see anything in relation to modules - rst2pdf with 0.6.5 worked for me, so I guess I have just overlooked a change I need to make to my setup. Sorry about the late reply! No problem Sphinx has changed something internally, and rst2pdf has not been able to follow it. Specifically, what was before the module index is now something else, and there's no code in rst2pdf to handle it. rst2pdf from SVN will work, but you will get no module index. Just to let you know that the SVN version works for me with only two small issues. - I get a warning " Using undefined style 'kbd', aliased to style 'normal'.", but I can't find where style "kbd" is referenced - on the cover page the date is shown a strangely, i.e. "day" is in bold and uses a larger font then the rest, i.e. "month" and "year" are about 2/3 of a line down and over to the right by a few spaces. Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] rst2pdf and 1.0.3 Sphinx issues, was - Finally got around to upgrade to 1.x
Has anyone else run into this? - Maybe a more sensible subject line will
help to get some tips:)
I can build 'html' but when I try to build 'pdf' I get the following
exception.
[ERROR] pdfbuilder.py:120 global name '_' is not defined
Traceback (most recent call last):
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 112, in write
appendices=opts.get('pdf_appendices', self.config.pdf_appendices)
or [])
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 197, in assemble_doctree
index_nodes=genindex_nodes(genindex)
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 395, in genindex_nodes
indexlabel = _('Index')
NameError: global name '_' is not defined
Running Sphinx v1.0.3
Is a correction available for this?
I worked around it by changing it to "indexlabel = 'Index', but then I
get this exception:
[ERROR] pdfbuilder.py:120 BuildEnvironment instance has no attribute
'modules'
Traceback (most recent call last):
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 112, in write
appendices=opts.get('pdf_appendices', self.config.pdf_appendices)
or [])
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 203, in assemble_doctree
if self.config.pdf_use_modindex and self.env.modules:
AttributeError: BuildEnvironment instance has no attribute 'modules'
I looked through the changes for 0.6.5 to 1.0.3 but don't see anything
in relation to modules - rst2pdf with 0.6.5 worked for me, so I guess I
have just overlooked a change I need to make to my setup.
--
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+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
--
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+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] Finally got around to upgrade to 1.x
I can build 'html' but when I try to build 'pdf' I get the following
exception.
[ERROR] pdfbuilder.py:120 global name '_' is not defined
Traceback (most recent call last):
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 112, in write
appendices=opts.get('pdf_appendices', self.config.pdf_appendices)
or [])
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 197, in assemble_doctree
index_nodes=genindex_nodes(genindex)
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 395, in genindex_nodes
indexlabel = _('Index')
NameError: global name '_' is not defined
Running Sphinx v1.0.3
Is a correction available for this?
I worked around it by changing it to "indexlabel = 'Index', but then I
get this exception:
[ERROR] pdfbuilder.py:120 BuildEnvironment instance has no attribute
'modules'
Traceback (most recent call last):
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 112, in write
appendices=opts.get('pdf_appendices', self.config.pdf_appendices)
or [])
File
"c:\python26\lib\site-packages\rst2pdf-0.15-py2.6.egg\rst2pdf\pdfbuilder.py",
line 203, in assemble_doctree
if self.config.pdf_use_modindex and self.env.modules:
AttributeError: BuildEnvironment instance has no attribute 'modules'
I looked through the changes for 0.6.5 to 1.0.3 but don't see anything
in relation to modules - rst2pdf with 0.6.5 worked for me, so I guess I
have just overlooked a change I need to make to my setup.
--
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+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Sphinx 1.0 beta 1 and 0.6.6 released
On 27/05/2010 09:46, Tony Vignaux wrote: Using easy-install to try and get 0.6.6 it only gives me version 1.0b. Is there any way I can get 0.6.6 (i.e. not the beta) I use a script for easy-install and would do this to get a specific version: ##egg = "sqlalchemy==0.5.8" # MULTI or SINGLE?!!! # # m = multi # Z = always unzip # a = always copy # x = exclude scripts # d = install directory # to install - Multiversion easy_install.main(['-Zmad', sitePKG, egg]) Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: Documenting Database Tables
On 07/04/2010 17:47, jmu wrote: However, the extension is not released yet as I had some problems with the sqlparse (http://code.google.com/p/python-sqlparse/) limitations at the time. Did you consider using SQLAlchemy (SA) instead of raw SQL? Actually, I didn't. My use case is about documenting the database from the raw DB creation script file. But if the SQLAlchemy is able to parse the file as well (with the nice addition of retrieving the info from actual DB as well) then certainly I should consider it. Thanks for the tip. While you can "feed" raw SQL to SA that would not be how one normally uses it. Wouldn't it be better to document the database itself? Here a very very very basic script to read the db (defined in dburl) and extract the table definition. engine = db.sa.create_engine(dburl, encoding='utf8', echo=False) meta = db.sa.MetaData() meta.reflect(bind=engine) for table in reversed(meta.sorted_tables): print table print 'primary key' for key in table.primary_key: print key print 'foreign keys' for key in table.foreign_keys: print key print 'columns' for col in table.columns: print col, col.type, col.description Showing the result of just one table: conseventit primary key conseventit.conseventitid foreign keys ForeignKey(u'bottag.bottagid') ForeignKey(u'consumption.consumptionid') ForeignKey(u'rating.ratingid') ForeignKey(u'cbbottle.cbbottleid') ForeignKey(u'consevent.conseventid') columns conseventit.conseventitid FBInteger() conseventitid conseventit.tagno FBString(length=32, convert_unicode=False, assert_unicode=None) tagno conseventit.fk_conseventid FBInteger() fk_conseventid conseventit.fk_cbbottleid FBInteger() fk_cbbottleid conseventit.fk_bottagid FBInteger() fk_bottagid conseventit.fk_consumptionid FBInteger() fk_consumptionid conseventit.created FBDate() created conseventit.updated FBDate() updated conseventit.fk_ratingid FBInteger() fk_ratingid Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: Documenting Database Tables
On 07/04/2010 13:32, jmu wrote: Hi, I've started to write an extension that parses the SQL file into RST tables. However, the extension is not released yet as I had some problems with the sqlparse (http://code.google.com/p/python-sqlparse/) limitations at the time. The existing material: Documentation: http://jmu.koodiorja.com/static/rusty/doc/sqltable.html Code: http://bitbucket.org/jmu/rusty/ I'm hoping to release the extension some time in a future. Did you consider using SQLAlchemy (SA) instead of raw SQL? Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] ReStructuredTextToolsForGedit
Hi Justin, On 29/03/2010 21:43, Justin Rosen wrote: I was wondering what type of editor everyone uses for editing Sphinx rst files. I've spent a great deal of time perusing the internet finding a ton of different things including some WYSIWYG editors. I've just recently come across a plugin for gedit on linux. http://textmethod.com/wiki/ReStructuredTextToolsForGedit This comes with a preview window which uses docutils to generate it's output. This works great, except that it doesn't like the sphinx directives. It looks like the plugin boils down to this single line from docutils.core import publish_string html = publish_string(text, writer_name='html') Is there similar code for using sphinx? import sphinx html = sphin.FUNCTION(text, ...) 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 correct me on this. Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] rst2pdf with sphinx
Hi, On 16/03/2010 19:44, anatoly techtonik wrote: Ahem. So. How to use rst2pdf with sphinx? There is some good doc in the manual for this - towards the end of the PDF version. http://lateral.netmanagers.com.ar/static/manual.pdf Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] rst2pdf - manual and sample conf file
Hi Roberto, On 15/03/2010 17:47, Roberto Alsina wrote: ... Well, the manual is shipped with the software, too :-) I am very good in overlooking things, but where is it being installed to? There is no doc folder nor do I find a rst2pdf.pdf in the Python 2.5 folder tree ;-) . Werner P.S. Thanks for the quick fix and the sample project, will look at it over the next few days. -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] rst2pdf - manual and sample conf file
Hi Roberto, In the doc it refers to a sample config file, can't find this on my machine. I am on Windows so looked in "users/userid/.rst2pdf" and the rst2pdf installation folder. Some of these configuration options can be defined in the Sphinx conf.py, is this true for all of them by just prefixing "pdf_"? BTW, only link to the manual I found is a "small link" under features - you might want to make it a bit more prominent. Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] rst2pdf 0.13.1 released
Hi Roberto, On 15/03/2010 16:36, Roberto Alsina wrote: ... Can't make it work, attached is what I did just for your reference or to put me right as I just guessed/trial and error on where it should go. Any chance you can just send me a style sheet which works for you - as I have seen some which have page numbers for the TOC and for pages here - http://www.freedrive.com/folder/236385, but I can't find the style sheets used for them. Ok, the bug is something else, a bit more complex. The real problem is that it's using the wrong page template for most of the document. Instead of cutePage define coverPage, and it should work. The bad side is that it will also add headers in cover pages and whatnot. That works as a work around. So, it is pretty broken. I have added this as Issue 280 (http://code.google.com/p/rst2pdf/issues/detail?id=280) Thanks. BTW, is there some documentation around which explains some of this magic? E.g. all these style sheet stuff, what needs to be overridden for e.g. the TOC to have different page numbers (i, ii etc). As soon as I fix it, there may be a 0.13.2 out. That would be great. Thanks again Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] rst2pdf 0.13.1 released
Hi Robert,
Thanks for the quick reply.
On 15/03/2010 15:50, Roberto Alsina wrote:
On Monday 15 March 2010 09:39:09 werner wrote:
Roberto,
...
Congratulations, you just found a bug in the stylesheet cascading code ;-)
Sorry about that ;-)
A quick fix: instead of creating sphinx-mine, copy sphinx.json as sphinx-mine,
add cutePage there, and use only sphinx-mine.
That may work (can't test it right now).
Can't make it work, attached is what I did just for your reference or to
put me right as I just guessed/trial and error on where it should go.
Any chance you can just send me a style sheet which works for you - as I
have seen some which have page numbers for the TOC and for pages here -
http://www.freedrive.com/folder/236385, but I can't find the style
sheets used for them.
Werner
--
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+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
{"pageSetup": {
"firstTemplate": "coverPage",
"margin-top": "8mm",
"margin-bottom": "8mm",
"margin-left": "12mm",
"margin-right": "12mm"
},
"cutePage": {
"frames": [
["0%", "0%", "100%", "100%"]
],
"showHeader" : true,
"showFooter" : true,
"defaultHeader" : "###Page###",
"defaultFooter" : "###Page###"
},
"styles": [
["heading", {
"backColor": "#F2F2F2",
"textColor": "#20435C",
"borderWidth": 0.3,
"borderColor": "#CC",
"leading": 10,
"spaceBefore": 16,
"borderPadding": [6,0,0,10],
"leftIndent": 0,
"fontSize": 10,
"fontName": "stdSansBold"
}],
["heading1", {
"fontSize": "200%"
}],
["heading2", {
"fontSize": "160%"
}],
["heading3", {
"fontSize": "140%"
}],
["heading4", {
"fontSize": "120%"
}],
["heading5", {
"fontSize": "110%"
}],
["heading6", {
"fontSize": "100%"
}],
["author", {
"parent": "bodytext",
"alignment": "TA_CENTER",
"fontSize": "120%",
"fontName": "stdSansBold"
}],
["code", {
"backColor": "#EEFFCC",
"borderWidth": 0.3,
"borderColor": "#AACC99",
"borderPadding": [6,0,0,4],
"spaceBefore": 0,
"allowOrphans": false,
"allowWidows": false
}],
["method", {
"parent": "bodytext",
"fontName": "stdSansBold"
}],
["exception", {
"parent": "bodytext"
}],
["data", {
"parent": "bodytext"
}],
["returns", {
"parent": "bodytext"
}],
["attribute", {
"parent": "bodytext"
}],
["class", {
"parent": "bodytext"
}],
["directive", {
"parent": "bodytext"
}],
["confval", {
"parent": "bodytext"
}],
["role", {
"parent": "bodytext"
}],
["admonition" , {
"borderColor": "#AACC99",
"backColor": "#EEFFCC",
"borderPadding": 8,
"borderWidth": 0.5,
"spaceBefore": 12,
"spaceAfter": 6,
"commands":[
[ "VALIGN", [ 0, 0 ], [ -1, -1 ], "TOP" ]
]
}],
["note" , {
"parent": "admonition",
"borderColor": "#CC",
"backColor": "#EE"
}],
["warning" , {
"parent": "admonition",
"borderColor": "#FF",
"backColor": "#FFE4E4"
}],
["seea
Re: [sphinx-dev] rst2pdf 0.13.1 released
Roberto,
You are too fast for me :-)
On 15/03/2010 13:15, Roberto Alsina wrote:
Since I suck at making releases, 0.13 had a bug in its setup.py and was
missing a crucial file.
So, I just released 0.13.1 with that fixed.
That one works.
I had noticed some time ago that some work had been done to get page
numbers onto header or footer.
Tried to get this working with some style stuff you mentioned ages ago,
but I don't get page numbers in my .pdf file.
Style sheet is attached and in my conf.py I have:
pdf_stylesheets = ['sphinx', 'sphinx-mine']
Is there somewhere a sample project I could look at to see how it should
be done.
Thanks
Werner
--
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+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
{
"pageTemplates" : {
"cutePage": {
"frames": [
["0%", "0%", "100%", "100%"]
],
"showHeader" : false,
"showFooter" : true,
"defaultHeader" : "something page for the header ###Page###",
"defaultFooter" : "something page ###Page###"
}
}
}
Re: [sphinx-dev] rst2pdf 0.13 released
Hi Roberto, On 15/03/2010 12:09, Roberto Alsina wrote: I've just uploaded the 0.13 version of rst2pdf, a tool to convert reStructured text to PDF using Reportlab to http://rst2pdf.googlecode.com Just updated and tried it. I see these errors: [WARNING] styles.py:574 Can't find stylesheet c:\python25\lib\site-packages\rst2pdf-0.13-py2.5.egg\rst2pdf\styles\styles.style [WARNING] styles.py:574 Can't find stylesheet c:\python25\lib\site-packages\rst2pdf-0.13-py2.5.egg\rst2pdf\styles\default.style [ERROR] findfonts.py:210 Unknown font: stdSansBold [ERROR] findfonts.py:210 Unknown font: stdSansBold [ERROR] styles.py:376 Unknown font: "stdSansBold",replacing with Helvetica The last three lines repeat some more. Checking the rst2pdf/styles folder I only have .json files. BTW, I am on Sphinx 0.6.3 Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] A word of thanks
Meera wrote: > Greetings, > > A happy 2010 to the development team of sphinx, and the community > behind it. > + a lot :-) Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] ReST filter for aspell?
Lennart Regebro wrote: > Hi all! > > It would be nice to have a ReST/Sphinx filter for aspell. I have no > clue how to make such a thing, and do not exactly feel like learning > it at the moment. :) Maybe somebody else have done it already? > > Are you looking for spell checking support for .rst, or ? If the first then you might want to check out Ulipad which does support spell check and editing of .rst files. Both .rst support and spell check are plug-ins and have to be enabled, the later uses pyenchant (I use Py2.6, latest Ulipad from SVN and pyenchant 1.5.3 on Win) which needs to be installed separately. Unfortunately it doesn't know about Sphinx extensions to .rst and therefore it's single .rst doc rendering/preview in an html window is not as good as it could be. All the best for the New Year, especially great health to everyone. Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: rst2pdf - a couple of questions
Hi Roberto,
Roberto Alsina wrote:
> On Wednesday 25 November 2009 12:20:45 werner wrote:
>
>> Do I understand correctly, as I only want to add page numbers I could do:
>>
>> pdf_stylesheets = ['sphinx', 'sphinx-mine', ]
>>
>> And sphinx-mine.json would just need to contain:
>>
>> {
>> "pageTemplates" : {
>> "cutePage": {
>> "showFooter" : true,
>> "defaultFooter" : "###Page###"
>> }
>> }
>> }
>>
>>
>
> Yes, that should work.
>
No luck, above solution does not work or just having a "sphinx-mine"
without "sphinx" does not work.
I.e. the style is definitely changing, but there is no page number at
the bottom.
I just did another test.
my sphinx-mine.json contains:
{
"pageTemplates" : {
"cutePage": {
"frames": [
["0%", "0%", "100%", "100%"]
],
"showHeader" : true,
"showFooter" : true,
"defaultHeader" : "something page for the header ###Page###",
"defaultFooter" : "something page ###Page###"
}
}
}
and conf.py:
pdf_stylesheets = ['sphinx-mine']
The PDF is generated with just about no formating but there is no
footer, nor any header. I know that style-mine is used as when I forgot
the comma after the newly inserted line for "defaultHeader" I got an error.
Werner
--
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+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: rst2pdf - a couple of questions
Still me,
Roberto Alsina wrote:
> You could create your custom stylesheet with something like this:
>
> {
> "pageTemplates" : {
> "cutePage": {
> "frames": [
> ["0%", "0%", "100%", "100%"]
> ],
> "showHeader" : false,
> "showFooter" : true,
> "defaultFooter" : "###Page###"
> }
> }
> }
>
>
First tried to integrate this into sphinx.json, but I got errors. So, I
stepped back a bit and just creat sphinx-mine.json which contains just
the above.
And my conf.py has:
pdf_stylesheets = ['sphinx-mine', ]
However this doesn't give me any page numbers and obviously a very
simple layout in general.
> Hope that helps!
>
Do I understand correctly, as I only want to add page numbers I could do:
pdf_stylesheets = ['sphinx', 'sphinx-mine', ]
And sphinx-mine.json would just need to contain:
{
"pageTemplates" : {
"cutePage": {
"showFooter" : true,
"defaultFooter" : "###Page###"
}
}
}
Thanks for being patient with me
Werner
--
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+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: rst2pdf - a couple of questions
Hi Roberto, Roberto Alsina wrote: > On Wednesday 25 November 2009 10:11:36 werner wrote: > >> That would be great. >> >> Any chance that you could also allow for page numbers (e.g. Page 'n' or >> Page 'n' of 'tn' or similar), either in the header or footer of each >> page - or is there some support for this already and I have not seen >> it? This would be especially useful for users who print out the PDF. >> > > Indeed this is already implemented in part :-) > > On headers and footers you can use these: > > ###Page### > Replaced by the current page number. > ###Title### > Replaced by the document title > ###Section### > Replaced by the currect section title > ###SectNum### > Replaced by the currect section number. > > No support for a total number of pages yet. > > Thanks for the quick response. Sorry but I need a bit more help on how to do this. Searched in rst2pdf and found that "###Page###" is used in the styles.json file, so I guess that adding this style to my list of pdf_stylesheets would do the trick. But no luck, I currently have "pdf_stylesheets = ['sphinx', 'styles', ]". Is this where I should set it, or am I missing the point? Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] Re: rst2pdf - a couple of questions
Hi Roberto, ralsina wrote: > On Nov 24, 7:32 am, Roberto Alsina wrote: > >> On Tuesday 24 November 2009 05:16:42 werner wrote: >> >>> What is the easiest way to get a logo onto the PDF cover page? >>> >> This still needs work, the cover page is pretty much fixed. You could just >> replace the first page after the PDF is done, but that's not a real solution. >> > > I am now thinking about adding some templating support for rst2pdf > which should solve this specific problem. > > That would be great. Any chance that you could also allow for page numbers (e.g. Page 'n' or Page 'n' of 'tn' or similar), either in the header or footer of each page - or is there some support for this already and I have not seen it? This would be especially useful for users who print out the PDF. Best regards Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] rst2pdf - a couple of questions
Is it possible to set an option that "commenting" the PDF is allowed? Currently if you check the PDF's Properties (under menu File/Properties/Security) it is set to "Commenting - Not allowed")? What is the easiest way to get a logo onto the PDF cover page? Thanks in advance for any hints on this. Werner -- 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+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] Re: rst2pdf - image sizes
Roberto, Roberto Alsina wrote: ... > You are using simple tables. The ..image and the :width: are in separate > cells. > > Please see > http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#simple- > tables > > "Simple tables allow multi-line rows (in all but the first column)", "Each > line of text starts a new row, except when there is a blank cell in the first > column. In that case, that line of text is parsed as a continuation line." > > Simple tables are... not so simple :-( > Thanks for pointing me to the doc again, I just don't read this stuff carefully enough. As I don't want another column I ended up going with grid tables instead. Werner --~--~-~--~~~---~--~~ 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: rst2pdf - image sizes
Nearly there, but this is probably an rst issue, i.e. how to format the following correctly so that ":width:" is not considered text? === == Vinoté Wrap tag Vinoté Neck tag .. image:: _images/tagWrap.jpg .. image:: _images/tagNeck.gif :width: 7cm :width: 7cm === == Hopefully above will come through corrected aligned. The "width" line is just shown as text in the generated output. I searched in the Sphinx and rst documentation but can't find anything helpful for the above. Werner --~--~-~--~~~---~--~~ 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: rst2pdf - image sizes
werner wrote: > I get the following warning for all my images (BTW, most of them are > screen captures of an application) as I have not defined a width setting. > > [WARNING] createpdf.py:377 Using image > C:\Dev\twcb-doc\en\source\_screenimages\initial.png without specifying > size.Calculating based on image size at 96dpi [near line UNKNOWN in file > UNKNOWN] > > With the warning the generated PDF has the above image with a size of > about 2/3 of the width on A4 paper. > > Would like to get rid of the warnings as they "hide" other warnings and > thought to use e.g. ":width: 80%", however when I do this the image > above is going to be tiny (maybe 1 or 2 cm wide). > > I then tried to use ":width: 14cm", but again the image is very small. > > I like to get rid of the messages, but keep the size rst2pdf uses when I > don't specify any "width" - what setting should I use to accomplish this? > In the past to get "html" builder to do what I wanted with the images I used ":scale:". If I replace ":scale:" with ":width:" it looks like I get what I would like to see for both the "html" and "rst2pdf" builders. Werner --~--~-~--~~~---~--~~ 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] rst2pdf - image sizes
I get the following warning for all my images (BTW, most of them are screen captures of an application) as I have not defined a width setting. [WARNING] createpdf.py:377 Using image C:\Dev\twcb-doc\en\source\_screenimages\initial.png without specifying size.Calculating based on image size at 96dpi [near line UNKNOWN in file UNKNOWN] With the warning the generated PDF has the above image with a size of about 2/3 of the width on A4 paper. Would like to get rid of the warnings as they "hide" other warnings and thought to use e.g. ":width: 80%", however when I do this the image above is going to be tiny (maybe 1 or 2 cm wide). I then tried to use ":width: 14cm", but again the image is very small. I like to get rid of the messages, but keep the size rst2pdf uses when I don't specify any "width" - what setting should I use to accomplish this? Werner --~--~-~--~~~---~--~~ 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: rst2pdf version 0.12.1 released
Roberto and I had some of list communication, so the following is just
for the archive.
werner wrote:
> Roberto,
>
> Roberto Alsina wrote:
>
>> On Friday 16 October 2009 05:49:37 werner wrote:
>>
>>
>>> Roberto,
>>>
>>> Roberto Alsina wrote:
>>>
>>>
>>>> On Thursday 15 October 2009 11:43:23 werner wrote:
>>>>
>>>>
>>>>> Roberto,
>>>>>
>>>>> Made a little bit of progress.
>>>>>
>>>>> Added this to my conf.py:
>>>>> import pkg_resources
>>>>> pkg_resources.require("rst2pdf") # get latest version
>>>>> import rst2pdf
>>>>>
>>>>> I am still getting "Builder name pdf not registered
>>>>>
On Win Vista I still need to do the import as shown above in my conf.py.
>>>>>
...
>>>
>>>
>>>>> [ERROR] createpdf.py:1344 Missing image file:
>>>>> C:\Dev\twcb-doc\_screenimages\initial.png [near line UNKNOWN in file
>>>>> UNKNOWN]
>>>>>
This problem is resolved as of rev 1220.
Thanks to Roberto for creating this and helping me out to resolve the
problems I had.
Werner
--~--~-~--~~~---~--~~
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: rst2pdf version 0.12.1 released
Roberto,
Roberto Alsina wrote:
> On Friday 16 October 2009 05:49:37 werner wrote:
>
>> Roberto,
>>
>> Roberto Alsina wrote:
>>
>>> On Thursday 15 October 2009 11:43:23 werner wrote:
>>>
>>>> Roberto,
>>>>
>>>> Made a little bit of progress.
>>>>
>>>> Added this to my conf.py:
>>>> import pkg_resources
>>>> pkg_resources.require("rst2pdf") # get latest version
>>>> import rst2pdf
>>>>
>>>> I am still getting "Builder name pdf not registered"
>>>>
>>> You should not need to do anything like it. What happens if you do what
>>> the manual says and add 'rst2pdf.pdfbuilder' to your extensions?
>>>
>>> For example:
>>>
>>> extensions = ['sphinx.ext.autodoc','rst2pdf.pdfbuilder']
>>>
>> I have this in my conf.py and get the error.
>>
>>
>>>> [ERROR] createpdf.py:1344 Missing image file:
>>>> C:\Dev\twcb-doc\_screenimages\initial.png [near line UNKNOWN in file
>>>> UNKNOWN]
>>>>
>>> Well, does C:\Dev\twcb-doc\_screenimages\initial.png exist or not? If it
>>> doesn't exist, that's the problem. If it does... well, then it's a bug in
>>> rst2pdf and I would love a self-contained example of it.
>>>
>> The project builds without error when I use html or htmlhelp builder.
>>
>
> You know, if you don't answer the questions I ask you, it's really,
> **really**
> hard for me to help you.
>
Sorry that I was not clear. What I meant is that html builds and I can
see the images in the created html files.
> However, if you really need to know, the HTML writer doesn't care if the
> images exist or not, because al it needs to do is write src="_screenimages/initial.png">
>
Yes, the image exists.
> On the other hand, rst2pdf has to read the image and actually put it inside
> the PDF. So, a missing image when you build HTML is no problem, but when you
> build a PDF it's a big problem.
>
In my test project and in my real project the PDF file is now created,
but all the places I check for images (did only do two or three in my
real project, and the only one in the test project) the PDF only has an
"image" place holder (no parking sign) as can be seen on the attached
pdf which is the output I get from my test project.
Maybe you see different results as you seem to be running on a *nix
system while I am on Windows Vista.
Werner
--~--~-~--~~~---~--~~
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
-~--~~~~--~~--~--~---
testpdf.pdf
Description: Adobe PDF document
[sphinx-dev] Re: rst2pdf version 0.12.1 released
Roberto,
I did a "sphinx-quickstart" and patched the make.bat file to support the
pdf builder (copied doctest section and changed doctest to pdf).
When running make I get:
Extension error:
Could not import extension rst2pdf.pdfbuilder (exception: No module
named rst2pdf.pdfbuilder)
Added the following to conf.py
import pkg_resources
pkg_resources.require("rst2pdf") # get latest version
import rst2pdf
Then it runs.
If I do a "make html" all is fine, but "make pdf" I get the error
mentioned in the last email, however the pdf is built (which is a step
further then I get with my project).
Attaching a Zip is not allowed, I'll send it to you directly.
Hope this helps
Werner
--~--~-~--~~~---~--~~
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: rst2pdf version 0.12.1 released
Roberto,
Roberto Alsina wrote:
> On Thursday 15 October 2009 11:43:23 werner wrote:
>
>> Roberto,
>>
>> Made a little bit of progress.
>>
>> Added this to my conf.py:
>> import pkg_resources
>> pkg_resources.require("rst2pdf") # get latest version
>> import rst2pdf
>>
>> I am still getting "Builder name pdf not registered"
>>
>
> You should not need to do anything like it. What happens if you do what the
> manual says and add 'rst2pdf.pdfbuilder' to your extensions?
>
> For example:
>
> extensions = ['sphinx.ext.autodoc','rst2pdf.pdfbuilder']
>
I have this in my conf.py and get the error.
>
>> [ERROR] createpdf.py:1344 Missing image file:
>> C:\Dev\twcb-doc\_screenimages\initial.png [near line UNKNOWN in file
>> UNKNOWN]
>>
>
> Well, does C:\Dev\twcb-doc\_screenimages\initial.png exist or not? If it
> doesn't exist, that's the problem. If it does... well, then it's a bug in
> rst2pdf and I would love a self-contained example of it.
>
The project builds without error when I use html or htmlhelp builder.
Will setup a new project from scratch and see if I can recreate it in
there. If I can recreate I post the project zip'd here?
Werner
--~--~-~--~~~---~--~~
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: rst2pdf version 0.12.1 released
Roberto,
Made a little bit of progress.
Added this to my conf.py:
import pkg_resources
pkg_resources.require("rst2pdf") # get latest version
import rst2pdf
I am still getting "Builder name pdf not registered" but it does not
seem to matter as I also get tons of:
[ERROR] createpdf.py:1344 Missing image file:
C:\Dev\twcb-doc\_screenimages\initial.png [near line UNKNOWN in file
UNKNOWN]
[ERROR] createpdf.py:1344 Missing image file:
C:\Dev\twcb-doc\_images\tagPrintSampleLabel.png [near line UNKNOWN in
file UNKNOWN]
Most of my image directives look like this:
.. figure:: _screenimages/dialogProgramError.png
:scale: 75
:align: center
:target: _images/dialogProgramError.png
|imagecaption|
Peaking at createpdf.py I wonder if this is just not yet supported?
Best regards
Werner
--~--~-~--~~~---~--~~
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: rst2pdf version 0.12.1 released
Roberto,
Roberto Alsina wrote:
> On Wednesday 14 October 2009 05:35:20 werner wrote:
>
>> Roberto,
>> I just tried with indextoc.rst which in my case contains the top
>> "toctree", but I am getting an error "indextoc.rst:62: (ERROR/3) Unknown
>> interpreted text role "ref"."
>>
>
> Yes, trying to process sphinx files directly usually will have errors because
> sphinx uses lots of custom roles and directives.
>
>
>> BTW, are there any plans to integrate this into Sphinx in some form and
>> have a "builder" command like we currently have for "html", or
>> "htmlhelp" etc?
>>
>
> It's there already, please look in the manual at the "Sphinx" section in page
> 37 :-)
>
> You can find the manual in rst2pdf, or here:
> http://lateral.netmanagers.com.ar/static/manual.pdf
>
>
Thanks for the quick answer.
If one would just read to the end of the manual - sorry about that.
It is great that this is already available, however I am still having
some problems - please bare with me I am still very very novice with Sphinx.
Error I get:
Sphinx error:
Builder name pdf not registered
copied _screenimages folder
copied _static folder
Running Sphinx v0.6.2
Extension error:
Could not import extension rst2pdf.pdfbuilder (exception: No module
named rst2pdf.pdfbuilder)
I am using a python script to run sphinx-build.
... settings things up (builders = ['html', 'htmlhelp', 'pdf']
for builder in builders:
targetFolder = os.path.join(os.path.join(curFolder, lang),
versionBuild + '-build-' + builder)
# TO REBUILD ALL
command = 'sphinx-build -ac ' + confFolder +' -b '+ builder
+' '+ sourceFolder +' ' + targetFolder
p = subprocess.Popen(command, stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
startupinfo=startupinfo)
Looking in the Sphinx doc I find:
Sphinx.add_builder(/builder/)¶
<http://sphinx.pocoo.org/ext/appapi.html?highlight=builder#sphinx.application.Sphinx.add_builder>
Register a new builder. /builder/ must be a class that inherits from
Builder
<http://sphinx.pocoo.org/ext/builderapi.html#sphinx.builders.Builder>.
But where do I do this? In my conf.py of the project or ?
I also added to my build script:
pkg_resources.require("rst2pdf") # get latest version
import rst2pdf
But that was not enough.
Thanks for any hints.
Werner
--~--~-~--~~~---~--~~
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: rst2pdf version 0.12.1 released
Roberto, Roberto Alsina wrote: > I just uploaded rst2pdf 0.12.1 to http://rst2pdf.googlecode.com > > This release has no new features, just some bugs fixed. If you had problems > with previous releases, this could be a good one to try ;-) > > For more details, see the changelog: > http://code.google.com/p/rst2pdf/source/browse/branches/0.12/CHANGES.txt > > Rst2pdf is a tool to generate PDF files directly from restructured text > sources via reportlab. > > Rst2pdf aims to support the full restructured text feature set, and is very > close to that goal, while also including some of the more experimental > features, like a source code directive with syntax highlighting and math > notation support with LaTeX-like syntax. > > It supports embedding arbitrary fonts, both True Type and PS Type 1, both > raster and vector images (including SVG and PDF), page transition effects, > multiple, flexible page layouts, cascading styles, and much, much more. > > Best regards, > Just installed with easy_install as I like to give it a try. What is the best .rst file in a project to use? I just tried with indextoc.rst which in my case contains the top "toctree", but I am getting an error "indextoc.rst:62: (ERROR/3) Unknown interpreted text role "ref"." BTW, are there any plans to integrate this into Sphinx in some form and have a "builder" command like we currently have for "html", or "htmlhelp" etc? Best regards Werner --~--~-~--~~~---~--~~ 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] Using Sphinx for my shareware - The Wine Cellar Book
Have converted the documentation from helpScribble to Sphinx and generate with it both html and chm help files in multiple languages. http://www.thewinecellarbook.com/doc/en/index.html Would be very pleased if the shareware is welcome on :-) http://sphinx.pocoo.org/examples.html Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: html_copy_source related request
Georg, Georg Brandl wrote: > Werner F. Bruhin schrieb: > >> If I set this to True the excerpt includes things like: >> >> .. include:: _substitutions.txt >> .. index:: >> .. figure:: >> >> Any chance that these directives could be suppressed from the excerpt? >> > > I don't think so, why shouldn't the source show everything? > The source should show everything, but it would be nice if the excerpt when doing a search does not show these things. > (At least you can get rid of the include using the rst_epilog config value.) > Didn't see this, will definitely make use of it. Thanks Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: html_copy_source related request
Georg Brandl wrote: > Werner F. Bruhin schrieb: > >> If I set this to True the excerpt includes things like: >> >> .. include:: _substitutions.txt >> .. index:: >> .. figure:: >> >> Any chance that these directives could be suppressed from the excerpt? >> > > I don't think so, why shouldn't the source show everything? > To me they don't bring anything to the "quality" of the excerpt. > (At least you can get rid of the include using the rst_epilog config value.) > I missed this one, will definitely use it and yes it will help - but :-) Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
html_copy_source related request
If I set this to True the excerpt includes things like: .. include:: _substitutions.txt .. index:: .. figure:: Any chance that these directives could be suppressed from the excerpt? Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Glossary - sorted flag
George, Georg Brandl wrote: > Werner F. Bruhin schrieb: > >> I am trying to use the sorted flag but get warning errors - is this a >> known issue? >> >> .. glossary:: >>:sorted: >> >> Drink >> A "Drink" in t >> >> etc >> >> But when I build I get tons of these warnings and the glossary page only >> contains the title "Glossary". >> >> C:\Dev\twcb-doc\en\source\overview010.rst:66: WARNING: term not in >> glossary: drinks >> > > You seem to have two different indentation levels in the directive -- the > "Drink" should be on the same level as ":sorted:". > Thanks for the quick reply and yes correction the indentation level did the trick. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Glossary - sorted flag
I am trying to use the sorted flag but get warning errors - is this a known issue? .. glossary:: :sorted: Drink A "Drink" in t etc But when I build I get tons of these warnings and the glossary page only contains the title "Glossary". C:\Dev\twcb-doc\en\source\overview010.rst:66: WARNING: term not in glossary: drinks I am using 0.6.1 on Python 2.5.4 on Vista. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Status update
Christophe de VIENNE wrote: > > > 2009/5/2 Georg Brandl mailto: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 is a change that > is acceptable for 1.0 release. > My point is that having an incompatibility with docutils will always > raise issues, and since changing docutils seems less realistic, it > leaves only one option. > One change path you could follow is to add the new name in the next > 0.6 release, but keeping the class alias and raise warning when it is > used. > > Now for the new name the only one I can think of is "pclass" (for > python class). But if Sphinx is used for documenting other languages > the rational of this name is lost. What about "sclass" then for Sphinx class? Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Sphinx version(s)?
Doug, Douglas Philips wrote: > Hello, > I'm just getting started with Sphinx, it got some press at pycon > 2009. :) > The web site indicates that Sphinx is at 0.6.1, but when I download > sphinx.pdf from the front page, the .pdf file says it is for version > 0.5. From a "eat your own dogfood point of view" this doesn't get me a > good feeling... Is that a bug in the .pdf? If not, can someone kick > the robot to build and post the current version? > If you look at: http://sphinx.pocoo.org/contents.html It looks like Georg is definitely eating his own dog food as that is already at 0.6.1+, which I assume is the dev version. I am no expert of Sphinx - just one of the small users, and I can only recommend it. It is easy to write .rst files and I think the out of the box quality of the generated documentation is very nice and will little effort one can even personalize the look and with some more effort one can do even more (just seeing what e.g. SQLAlchemy has done with theirs). Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Application draft
Timmie wrote: ... > Despite of Django, web2py might be an option: > http://www.web2py.com/ > > I have pondered into this recently. > It has jQuery built in and comes as a ready-to-start executable. > > This is just an idea. maybe you are alredy accostumated with Django. > I do not want to start a frameworks flamewar... > Maybe a consideration in the selection of one over the other framework should be if it uses Sphinx for it's documentation - just a thought. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: use snippet as input, produce snippet as output
John H Palmieri wrote: > On Mar 29, 9:35 pm, John H Palmieri wrote: > >> Hi, >> >> I'm using Sage, which you know now uses Sphinx. One aspect of Sage is >> its notebook interface: it can be run within a web browser. When you >> run Sage, you're running Python, and you can easily access docstrings >> interactively. I would like to use Sphinx to process those >> docstrings. So I won't be starting with a directory and various .rst >> files; instead, my input will be a string in ReST format (including >> substrings of the form `blah`, which ought to be formatted as >> mathematics: default_role = 'math' -- note that jsMath is installed), >> and I want my output to be, say, the body of the html document: >> something which I can just pass straight to the running web browser. I >> don't want to produce any files. Furthermore, since I'm already >> running Python with Sphinx installed, I don't want to run sphinx-build >> or any external program; I'm guessing that it would be faster just to >> call Python functions directly. So what should I do? >> > > Following up to myself, I want something like > > from docutils.core import publish_parts > output_string = publish_parts(input_string, writer_name='html') > ['body'] > > except this doesn't process math: I think I need Sphinx to do that. > Can I for example use publish_parts, setting writer_name to something > imported from Sphinx, to achieve this? > Would love to see something like this too, especially if this would handle all the Sphinx extensions one uses. It would be ideal for a .rst editor, it could then show on request how the page will look. Currently I use UliPad and/or Boa to edit .rst and they use docutils.publish_string but it does obviously not handle all the Sphinx stuff. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Header links
I have a indextoc.rst with my "top" toctree (maxdepth: 1), then going to the next level I have the "toctree" for that level (maxdepth: 2) and I have a indextocdetail.rst with a doctree instruction without any maxdepth definition. This works fine with just one little hick-up. When one navigates down from e.g. indextoc.rst (it's html version) to e.g. "First steps" which shows the above toctree representation - which is fine. However in the header area I get the "Table of content" title which is coming from the indextocdetail.rst. Is there anyway I could suppress this? Thanks for any hints Werner P.S. I am on 0.6.1 --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Question on Glossary
Paulette wrote: ... > Naturally, when it builds I get a warning because my glossary isn't > included in any toctree. I don't want the glossary it two places--it's > for all the docs, and I like it after the heading. I can live with 1 > warning and let others know to expect it, but if there is a way to > avoid the warning, it would be better. > Just noticed in the 0.6.1 doc a: .. toctree:: :hidden: That should probably do the trick for you. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: [GSoC] Some "web app" idea questions
Wojtek Walczak wrote: > Werner F. Bruhin napisał(a): > > Werner, > > >>> In the examples directory in Pyjamas package, there is an app called >>> dynamictable. While it's python source code is quite short (~400 lines >>> of code), after compilation to JavaScript it becomes quite big. The main >>> file is 527K big. My application will certainly be bigger than the >>> dynamictable example and I don't want to abuse users with 2MB long >>> JavaScript files. >>> >>> >> What about looking at TurboGears (http://www.turbogears.org) and what >> they have done for commenting their documentation (which is Sphinx based)? >> >> http://www.turbogears.org/2.0/docs/ >> > > thanks for the link! Disqus.com comments framework seems nice, but still > it is an external tool, so your options are quite limited. You can't add > new features just like that. Only realized it after I posted that they used an external tool for it. Great if it still provides to be a little bit helpful. > But their API description will certainly be > a point of reference for my future work. And they are using Django ;-) > That would really surprise me! That TurboGears would use a competing web framework, or are you saying that the Disqus site is using Django. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: [GSoC] Some "web app" idea questions
Wojtek Walczak wrote: > *** > > Roberto Alsina wrote: > > ''' > For this kind of app, I would give some thought to something like Pyjamas, > where you can create a modern AJAXy interface and all you would have to > implement as backend is some JSONRPC handlers, which are not hard at all > with > any web framework (or without one, either). > ''' > > Still reading about it. Roberto are you able to assess how big > would such an app be if written in Pyjamas (I mean - after compilation > to JavaScript)? > > In the examples directory in Pyjamas package, there is an app called > dynamictable. While it's python source code is quite short (~400 lines > of code), after compilation to JavaScript it becomes quite big. The main > file is 527K big. My application will certainly be bigger than the > dynamictable example and I don't want to abuse users with 2MB long > JavaScript files. > What about looking at TurboGears (http://www.turbogears.org) and what they have done for commenting their documentation (which is Sphinx based)? http://www.turbogears.org/2.0/docs/ Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: html > french output
Shubacka wrote: > Hi everybody, > While testing Sphinx, I've noticed that not-all-the-words are in > french (like "search", etc.). > Where is the file to be translated further in french? > I believe it is in this folder: C:\Python25\Lib\site-packages\Sphinx-0.5.1-py2.5.egg\sphinx\locale\fr\LC_MESSAGES There is some stuff in the sphinx.po and some in sphinx.js As you can see I am using 0.5.1 and for me the word "Search" is translated, however the description of what search does on the search page is not translated (i.e. the text starting with "From here you can search these documents ..". I can't find this in either of the two files, so it probably means that George has to define this in the code as translatable. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Problems with search function
Georg, Georg Brandl wrote: ... > Ah, you have the JS in your own _static folder? That shouldn't be necessary. > But it explains what happened, because those files are always copied after > the Sphinx builtin ones. > That is very quickly corrected :-) Thanks Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Problems with search function
Georg, Georg Brandl wrote: > Werner F. Bruhin schrieb: > > >>> Of course it was two different problems. :) >>> >>> In your case, it seems that your searchtools.js is not the one that is >>> shipped >>> with 0.5.1 -- the problem is that the page sources are missing. >>> >>> Can you check if the searchtools.js is properly copied in the output >>> directory? >>> There should be a condition checking for DOCUMENTATION_OPTIONS.HAS_SOURCE >>> in it. >>> >>> >> Can confirm that after I copied searchtools.js (actually did all *.js >> just to be sure) from the sphinx/static folder to my documentation >> _static folder the search works fine. >> >> BTW, it is the manual step one has to do after upgrading Sphinx x to y? >> Or should Sphinx detect this during the build process? >> > > Normally the static files are copied after each build, so I don't know what > prevented it in your case. If you delete the file and do a build, does Sphinx > copy it? > When I delete the files from my _static folder in my source tree they do get copied by Sphinx to the _static folder in my build tree. Any reason why one keeps them in the source tree? Maybe this caused a problem with my setup where the static folder is getting copied just before the build to handle my "multi" configuration stuff (which I can hopefully throw out when 0.6 is out) and maybe Sphinx only checks the file date/time and due to the copy the old one looked "newer". Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Problems with search function
Georg, Georg Brandl wrote: ... >>>> >>>> >>> Unfortunately problems with the search are hard to debug. Is your >>> documentation >>> online somewhere so that I can try it, or are the sources public? >>> >>> >> I have the same problems (at least it looks like it to me). I put the >> doc up on my web site, maybe seeing two different sites/docs might help you. >> >> http://www.spiritissimo.com/test/ >> > > Of course it was two different problems. :) > > In your case, it seems that your searchtools.js is not the one that is shipped > with 0.5.1 -- the problem is that the page sources are missing. > > Can you check if the searchtools.js is properly copied in the output > directory? > There should be a condition checking for DOCUMENTATION_OPTIONS.HAS_SOURCE in > it. > Can confirm that after I copied searchtools.js (actually did all *.js just to be sure) from the sphinx/static folder to my documentation _static folder the search works fine. BTW, it is the manual step one has to do after upgrading Sphinx x to y? Or should Sphinx detect this during the build process? Thanks Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Problems with search function
Georg, Georg Brandl wrote: > Max Landaeus schrieb: > >> I can not get the search function to work anymore. I get stuck with the >> message 'Preparing search...' and the ... after 'Searching' is blinking. >> Search used to work when I used Sphinx (in mid October 2008), but now >> when I installed latest version on a new computer I got this problem. >> >> Google brough up a discussion from November 2008 >> (http://www.mail-archive.com/sphinx-dev@googlegroups.com/msg00661.html). >> My problem seems to be the same as the problem described in that mail. >> Unfortunately I could not find any solution in that thread. It was said >> that the problem was fixed in version 0.5.1 - But I'm still having this >> problem with version 0.5.1! >> >> Anybody know how I can fix this? >> >> This is Sphinx 0.5.1 with Python 2.5.2 on Windows Vista. The problem is >> there both with IE 7.0 and Firefox 3.0.6. >> > > Unfortunately problems with the search are hard to debug. Is your > documentation > online somewhere so that I can try it, or are the sources public? > I have the same problems (at least it looks like it to me). I put the doc up on my web site, maybe seeing two different sites/docs might help you. http://www.spiritissimo.com/test/ Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: index page again
Chris h wrote: > On Thursday 29 January 2009 12:09:09 Werner F. Bruhin wrote: > > >> You might also check the section in the doc here: >> http://sphinx.pocoo.org/rest.html?highlight=headers >> > > Yup read all that. What I needed to get my head around was that the index.rst > file picks up the formating from the actual documents. > > That is counter intuitive from the other document management systems Ive used > where the layout is controll from a master file separating content from > layout. Once its understood how sphinx operates its actually rather clever > given what its designed to do. > > Now to find a good editor and Im off to the races. So far I've tested Ulipad > referenced on this list and its not bad. If there are other options I would > love to hear about it. Otherwise I will probably stick with KDE's kate or > Ulipad. > I currently use Ulipad. I like the preview it has, but it does not understand Sphinx specific instructions such as :toctree: etc, would be nice if one could teach it to at least know about them and not show them as errors. I have also a plug-in for Boa for .rst (done by Boa's author) but currently the preview is extremely slow and it has the same problem with the Sphinx specific instructions - but I believe the author is working on an improved support for .rst for the next release of Boa. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Multiple folders for images
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::" directives look relative to the source >> folder. >> >> So, I tried using a substitution but without success either. >> >> .. figure:: |imagebasefolder|_screenimages/dialogPurchaseNewWine.png >> >> Is there a way of doing the above without having to resort to renaming >> or copying whole folders with all the images on each build? >> > > I had a similar need for templates, and had my Makefile set an > environment variable that conf.py read to set the template path. > I see a template path, but I don't see any thing for the images. Currently they seem to have be relative to the source file. Work around is just to copy them to there, but would be nice to be able to set a variable - along the lines of the template path one. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Multiple folders for images
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 substitution but without success either. .. figure:: |imagebasefolder|_screenimages/dialogPurchaseNewWine.png Is there a way of doing the above without having to resort to renaming or copying whole folders with all the images on each build? Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Using the '-c' option on the sphinx-build
The doc states that various other files need to be present in this location/path when one uses this option. Is there a list of these files which need to be in the same folder and what files/folder need to be relative to this folder? Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
Re: Shinx spell checking plugin?
Jorge Vargas wrote: > Hi, We where working on updating the TurboGears2 sphinx sources and I > found a lot of typo's that could be found by a spell checker, which > got us thinking, Why not having a sphinx plugin to do this? Which in > turn made me write this email. > > Has anyone else think about this? > if so maybe someone has a private implementation you will want to share. > If not just exactly how hard will it be to write it? > any recommendations for a spell checking library? > > keep in mind I have never coded a sphinx plugin or interacted with a > spell checking library, which makes this twice as interesting to work > on. So with the right guidance I think I could make this happen. or > should I just forget about this and use an external tool? > Isn't that more of a job for whatever editor you use? I use UliPad (http://code.google.com/p/ulipad/ ) for the .rst files I write and it obviously could be used for .py files. Written in Python and wxPython. It uses the "enchant" spell checker, I use pyenchant-1.4.2-py2.5.egg-info as I could not get 1.5.x to work. Werner --~--~-~--~~~---~--~~ 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 -~--~~~~--~~--~--~---
