[sphinx-dev] Sphinx: Co-Maintainer(s) wanted
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Dear Sphinx users, dear Python community, unfortunately, it has turned out that at the moment I don't have enough spare time to fulfill my duties as Python core developer and release manager, as well as fully maintain my other open-source projects. Therefore, I'm looking for co-maintainers for Sphinx (http://sphinx.pocoo.org; http://bitbucket.org/birkenfeld/sphinx/). So if you want to be involved in the maintenance and evolution of *the* Python documentation tool, please let me know; either in the sphinx-dev group (sphinx-dev@googlegroups.com) or personally by email (ge...@python.org). Ideally, we can get a group of several people with push privileges going; of course I will try to be as much help as possible. Thanks, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.19 (GNU/Linux) iEYEARECAAYFAlCNeD0ACgkQN9GcIYhpnLC9QgCgsJnzpZl/+yX3iXuOD7ofjuia pSoAn0S/Zzi81vljPhGYYIBSn7fqL61e =AsLj -END PGP SIGNATURE- -- 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] autodoc and module variables
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 I agree. I will fix the doc to make this clearer. cheers, Georg On 03/16/2012 11:54 AM, Rob Reilink wrote: I have to say that the doc is not very clear: ...'documentation can either be put into a special-formatted comment'... but the colon is not mentioned. It is easy to miss the colon after the hash in the example in that section Rob -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk9kTnQACgkQN9GcIYhpnLDXCQCfTiYBHL4ulerkOBm6vG8S/rmv TnUAoIrnbzeMD/Bfidl+Np8rKNayMC7b =7azl -END PGP SIGNATURE- -- 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: Exception when using Sphinx 1.1.2 to create the Leo documentation
On 14.03.2012 16:15, VR wrote: Hello everyone, Am Samstag, 18. Februar 2012 09:36:39 UTC+1 schrieb VR: when running Sphinx 1.1.2 I receive the following exception. - See 'Log-1' for the exception: log-1 ... /log-1 and 'Log-2' for the output from 'sphinx-err-7u9urs.log': log-2 ... /log-2 Since this is my first post to this mailing-list, please advise if I missed something. For the record: After I upgraded Sphinx to version 1.1.3 the problem disappeared. Very nice, thanks for the update and your patience! Georg -- 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] PULL REQ: Add URL #anchor checking to 'linkcheck' builder
On 07.03.2012 17:23, Marti Raudsepp wrote: Hi! Last week I submitted a pull request to the Sphinx Bitbucket repository, but there has been no activity on the request. Is there another way to submit patches to Sphinx? Anyway, the patch downloads all pages that have '#' in their address, and then uses a simple HTML parser to check whether there are any name= or id= attributes with the anchor. I also found 4 broken links in Sphinx's own documentation using this. https://bitbucket.org/birkenfeld/sphinx/pull-request/45/add-url-anchor-checking-to-linkcheck I've now pulled and merged the code. Thanks for your contribution! Georg -- 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] Sphinx 1.1.3 released
Hi all, I'm happy to announce the release of Sphinx 1.1.3. It fixes over 20 bugs and buglets in the 1.1 series of Sphinx. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files). Website: http://sphinx.pocoo.org/ cheers, Georg -- 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] How to reduce memory usage of sphinx-build
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 01/06/2012 03:44 PM, Neck Acm wrote: Hi all, I am new to sphinx, I am trying to convert massive plain text files to well-organized html, not program documentation, just some plain text record. The source text files is about 116 MB, I use `sphinx-quickstart` to create config file, `make html` to build, then `sphinx-build` start to consume lots of memory, eventually eats all my memory ( 1.5 GB ), returning MemoryError, abort the build process I've tried to build with less files( 9.8 M ), sucessfully create beautiful html, means the config is fine, I also modified some option in conf.py like html_domain_indices = False html_use_index = False primary_domain = 'None' But still failed to build, and the output files are enormous big Is there any way to reduce memory usage in building and the file size of output html ? Hi, the question is how you organized your files. When you say the output files are enormous big, what exactly do you mean? Of course the HTML will be bigger than the text file, due to added markup, but that should not amount to more than, say, a factor of 3. Are you by chance working with lots of include directives, making one big document out of multiple files? Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk8HESgACgkQN9GcIYhpnLDGVwCfRb0L8nrz3rN+kpaIVFLGvq2x xSMAn3dtBqZmnjP7Fz/Xo2blVovoVbxG =1Tw/ -END PGP SIGNATURE- -- 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: Some characters rendering wrongly in HTML title output
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 25.11.2011 22:17, schrieb Guenter Milde: On 2011-11-25, Guenter Milde wrote: On 2011-11-25, Friedrich Romstedt wrote: Am 25.11.2011 um 08:44 schrieb Guenter Milde mi...@users.sf.net: On 2011-11-24, Friedrich Romstedt wrote: I'm experiencing some problem with Sphinx 1.1.2 (and also an earlier version from July), that some characters in my HTML title are occuring as strange Unicode character sequences in the HTML. Here's an example: http://www.roentgen.physik.uni-goettingen.de/~fromstedt/ Watch the title displayed in the browser (not the headline, but the title). The two-character sequence is hardcoded like this in the HTML, apparently (inspection with Firefox Show Source). I cannot tell the reason. Found out more: * if I download the page and open the copy from file, title and section tags are OK. * if i manually set the encoding (in my Firefox it is AnsichtZeichenkodierung and I click at the already selected utf-8), the problem vanishes as well. (The Seiteninformationen show ``Coding: ISO-8859-1`` before and ``Coding: UTF-8`` after this change.) Guess: The http server sends some header that makes the browser reading the document as ISO-8859-1 (latin1) encoded. That would be my guess too. Solutions: * configure the server to announce utf-8 if the doc is utf-8 encoded, or That would be the preferred solution. * configure Sphinx to write ascii or latin1 encoded documents (in Docutils the setting is output-encoding, should be something similar in Sphinx) Sphinx has html_output_encoding. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk7QhKAACgkQN9GcIYhpnLA1cACgnMxAEMRODMCKT+1P9tGOJusd VYoAoJ3gFE3D6Q69bfeHzmhljmqVpsT4 =Xz4s -END PGP SIGNATURE- -- 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] Override the release name
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/31/2011 06:14 PM, Jan Ulrich Hasecke wrote: Hi, is it possible to overwrite the release name in Sphinx. I want to have a custom name (subtitle) on the pdf-output. You can set release in conf.py, or give it on the command line, with the -D option. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6vpMEACgkQN9GcIYhpnLBnogCfbXbI8uqWKDAzpfdNYhlzAhgR 80cAoIim4TTqstWnB8G1MOHQRFSnjd1I =VNeJ -END PGP SIGNATURE- -- 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: parsed-literal problems
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/29/2011 01:19 PM, Guenter Milde wrote: On 2011-10-29, Andrea Crotti wrote: On 10/28/2011 10:28 PM, Guenter Milde wrote: What do you expect and what do you get? I would think to get the code highlighted, instead is just not recognized as code, I am not sure parsed-literal content should be highlit as code. (But, of course a consistent behaviour is to be expected - i.e. either always or never highlight parsed-literal as code.) Hi Günter, you are of course right. If I had my way, I wouldn't highlight anything in parsed-literal blocks. But the problem is that I found no way to distinguish between normal literal blocks and parsed literal blocks that have only plain (i.e. nothing that was parsed) text inside... cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6vpHMACgkQN9GcIYhpnLBgeQCcDaMBi5L8cm5kUJpefrrZriRH TH0AoJta8i/eLvoys6962qggXmBgd0wv =QOzI -END PGP SIGNATURE- -- 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] Override the release name
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 11/01/2011 09:43 AM, Jan Ulrich Hasecke wrote:
Am 01.11.11 08:50, schrieb Georg Brandl:
On 10/31/2011 06:14 PM, Jan Ulrich Hasecke wrote:
Hi,
is it possible to overwrite the release name in Sphinx.
I want to have a custom name (subtitle) on the pdf-output.
You can set release in conf.py, or give it on the command line, with
the -D option.
But this does not change the release-name which defaults to Release. I
want to change it, because I do not write the documentation of a software
project.
Ahh. Now I get it :)
You can set
latex_elements = {'releasename': 'Whatever'}
in conf.py to do that.
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.18 (GNU/Linux)
iEYEARECAAYFAk6vszMACgkQN9GcIYhpnLBgUACfQ9QrxC91wR40i/1B6MdE4eMN
bh8AnR6LWN/J/NaUrE19BKVKIJo7S6Gq
=FMuc
-END PGP SIGNATURE-
--
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] Sphinx 1.1.1 released
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.1.1, a bug-fix release in the 1.1 series, fixing a number of bugs of the initial 1.1 release. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files). Website: http://sphinx.pocoo.org/ cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6wBcsACgkQN9GcIYhpnLBZ9ACgqRh4+UDIHYeWP+8qWumAGTNA e8sAn1lfnSzg54a3JpDu6b+2OBxxq9gi =9opx -END PGP SIGNATURE- -- 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] Sphinx 1.1.2 released
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm announcing the release of Sphinx 1.1.2, codename 1.1.1 Is A Silly Version Number Anyway. It fixes building from the source tarball with Python 3 by actually including our custom 2to3 fixers. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files). Website: http://sphinx.pocoo.org/ cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6wW24ACgkQN9GcIYhpnLBpGgCbBWIFGZYPBeF3e1WUntkY5Fr6 3i0AniljnCYggPF4UFw+UR78s67QBlhg =Fe2R -END PGP SIGNATURE- -- 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] Sphinx 1.1 released
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.1, a new feature release. The full changelog is at http://sphinx.pocoo.org/changes.html. Highlights == * Added Python 3.x support. * Added a Texinfo builder. * Added i18n support for content, a ``gettext`` builder and related utilities. * Added the ``websupport`` library and builder. * Added a ``sphinx-apidoc`` script that autogenerates a hierarchy of source files containing autodoc directives to document modules and packages. * Added an `index` role, to make inline index entries. * Added the :mod:`sphinx.ext.mathjax` extension. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files). Website: http://sphinx.pocoo.org/ cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6SE6QACgkQN9GcIYhpnLD/cgCbBMABuQe3pTIfSekXaNtPC47r IVUAoI5PzoWpIZr7I2wUZOXOIm3awHOW =Do0C -END PGP SIGNATURE- -- 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] referencing hyperlinks using :ref:
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/06/11 22:00, Christian Rohling wrote: Hey everyone, I am new to sphinx, and am using it to document a project. I have run into a something that I feel I should be able to do, but cannot find out how. I want to reference a hyperlink section from another file, for example: file_a.rst: :ref:`tag_in_file_b` file_b.rst: .. tag_in_file_b: http://www.example.com I have tried to do this, but so far it doesn't really seem to be working. I can access the hyperlink within the same rst file just fine using something like 'tag_in_file_b'_ but not with the :ref: tag. Any input would be greatly appreciated. This isn't possible, and I would argue that if it worked it would also be misleading: :ref: is supposed to make internal references, not external hyperlinks. What you can do is to put your hyperlink references in a common include file, and to include that (using ``.. include::``) in all files where you need it (if you use it from everywhere, you can also use the rst_epilog config value.) cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6Owp0ACgkQN9GcIYhpnLBzzQCgpbWKR6fJQrXTYxXBqW1ApqfA MdIAoKJyWxzKTVEYxn5lArc1khQgo127 =+xsh -END PGP SIGNATURE- -- 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] disable search for html
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/02/11 14:39, mbedward wrote: Hello folks, For html output, I would like to disable creation of the search index and search page but I haven't been able to find any clues on how to do this in the docs or archived posts. I suspect I'm missing the something obvious. If someone could give me a clue I would be grateful. Hi Michael, at the moment there is no way to completely disable the search. We could add such a config value in 1.1 -- would you be interested in contributing that as a patch? cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6OwucACgkQN9GcIYhpnLDBKwCgjlp7fJXKb4SDcVxrcssOks0m uYUAn2entFIKNrm9q0Px4+Ji6/k26IAh =SV59 -END PGP SIGNATURE- -- 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] no quick search in Konqueror
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/04/11 22:40, Paulette wrote: Hi, I have a user who cannot see the Quick Search box when he uses the Konqueror brower (on Linux). This search box appears for all the other browsers we tried (IE, Chrome, Safari, Firefox, etc.). If you look at the source code it shows: div id=searchbox style=display: none h3Quick search/h3 form class=search action=search.html method=get input type=text name=q size=18 / input type=submit value=Go / input type=hidden name=check_keywords value=yes / input type=hidden name=area value=default / /form p class=searchtip style=font-size: 90% Enter search terms or a module, class or function name. /p /div Why does the Quick Search box appear for the other browsers but not this one? And how do we fix it? Actually, the first line says: div id=searchbox style=display: none So why does the Quick search even appear? It's in our left sidebar. If anyone can enlighten, please so so. Hi Paulette, the search box has display: none set which is afterwards removed via JavaScript (see the script after the div you posted). The reasoning is that if JavaScript is disabled, the search box won't work anyway... cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6MXnIACgkQN9GcIYhpnLB/WgCdH5pqDJy2RoWbSXVN9W1dEiuU wCYAni+gveKQDHSNzjphyvkO1KuKde2t =34+9 -END PGP SIGNATURE- -- 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 tcl highlighting problem
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 10/02/11 01:41, bulletmark wrote:
The small tcl code fragment:
.. code-block:: tcl :linenos:
set a 1 puts ${a}
fails to render in sphinx but does render when I run it through pygmentize
manually. Also runs fine in tclsh of course. Have tried sphinx 1.0.7,
1.0.8, and 1.1. If I take out the {} then it renders ok. This problem also
occurs with other valid tcl contructs like \ end of line continuation
etc. Fails as a literal include also. Beats me.
Hi,
I can't reproduce that this works with standalone pygmentize: Pygments also
generates an error token for the snippet you posted.
Insofar, if it is valid TCL, this is a bug in Pygments.
cheers,
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.18 (GNU/Linux)
iEYEARECAAYFAk6MXycACgkQN9GcIYhpnLAixACdF4O4Apk58s7NlJpsR+PT/rsK
GxEAn3Jr2TPYIjSI60T9VNqmmQu3CTGG
=17Ts
-END PGP SIGNATURE-
--
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] Error in cpp:namespace directive
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 09/30/11 19:39, Jack Poulson wrote: Hello, It would appear that the C++ domain's 'cpp:namespace' directive does not work (in 1.0.7 or 1.0.8). For instance, when adding in the following code: .. cpp:namespace:: mpi .. cpp:clase:: Test A test class. I get the following error: /Users/poulson/Source/elemental/doc/source/imports.rst:16: ERROR: Error in cpp:namespace directive: no content permitted. .. cpp:namespace:: mpi .. cpp:class:: Test A test class. Perhaps I'm using the namespace directive incorrectly? I tried to use it in a way that mirrored the cpp:class directive. I very much appreciate how responsive this list is! Hi Jack, cpp:namespace is supposed to be used like py:module: it is in effect until the end of the file or the next cpp:namespace. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6MYJkACgkQN9GcIYhpnLDUkwCfSGW86raK+gJOFEyhHXdXTz2l ZXUAoIi8j6CW9Fujtq+5egyKJX+XU+nz =o/Gn -END PGP SIGNATURE- -- 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 v1.0.7/automodule does load package, only shared lib
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 09/29/11 17:04, Avi Bahra wrote: If I have a C++ python extension say _ecflow.so. The normal convention is to place it in a directory with same name as extension. ecflow/ _ecflow.so __init__.py where __init__.py: has as the first line: from _ecflow import * It appears that automodule facility does not seem to honour this: So it appears that it does *NOT* treat the directory as a package. It requires the name of the extension to be 'ecflow.so' ie no leading underscore Hence if I declare class/functions in __init__.py they are not accessible for documentation ? Hi Avi, how are you importing your module from automodule? How does the .rst look? Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6MYLoACgkQN9GcIYhpnLDUMQCfRo8JPNRdlRQmtYeqB+xX667Z urAAoJJ+wt4ltdBAmJkEvQ7qOA6EQdKs =Szis -END PGP SIGNATURE- -- 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 tcl highlighting problem
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/05/11 16:02, bulletmark wrote: I was running pygmentize to my terminal and after your comment I have realized that some of the output is underlined so I guess that means pygmentize believes it is invalid syntax? Yep, this is how the default style shows Pygments Error tokens. Either way, why does sphinx just fail to render the output at all if the highlighter trips over some syntax? Is there any message where a user can see the reason why his code is not highlighting? It's because then you can keep the default highlight language even if you have a shell/text/whatever sample inbetween. I spent ages on this problem thinking I had an environment problem. The code section is not even being line numbered at all. More particularly, can a user tell sphinx to ignore syntax errors and render (as best it can) anyway? I imagine there will always be different language dialects which a general purpose highlighter will not completely accommodate. Yep, we're planning an option to customize this in 1.1. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk6MbXgACgkQN9GcIYhpnLCwswCeNecHcgiZiBPKj5lcp35AKhUJ FcAAoJwLXB2+t7L6ghsVtB5Wx6+g93lK =Z0cv -END PGP SIGNATURE- -- 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 1.0.8 released
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 I see... this is with docutils 0.6, right? I'll update the tests to care for this case, but you should upgrade to at least 0.7 anyway. cheers, Georg Am 24.09.2011 21:12, schrieb Chris Lea: I get two errors when I try to run the test suite on an Ubuntu Maverick machine. Not sure if I'm missing something? chl@vetest01:~/Packages/PythonSphinx/Sphinx-1.0.8$ python tests/run.py Running Sphinx test suite... FF... == FAIL: Failure: AssertionError (Warnings don't match: --- Expected (regex): \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/autodoc_fodder.py:docstring of autodoc_fodder\.MarkupError:2: WARNING: Explicit markup ends without a blank line; unexpected unindent\.\n? \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/images.txt:9: WARNING: image file not readable: foo.png \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/images.txt:23: WARNING: nonlocal image URI found: http://www.python.org/logo.png \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/includes.txt:\d*: WARNING: Encoding 'utf-8-sig' used for reading included file u'.*?wrongenc.inc' seems to be wrong, try giving an :encoding: option\n? \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/includes.txt:4: WARNING: download file not readable: nonexisting.png \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/objects.txt:\d*: WARNING: using old C markup; please migrate to new-style markup \(e.g. c:function instead of cfunction\), see http://sphinx.pocoo.org/domains.html \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/images.txt:20: WARNING: no matching candidate for image URI u'foo.\*' \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/markup.txt:: WARNING: invalid index entry u'' \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/markup.txt:: WARNING: invalid pair index entry u'' \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/markup.txt:: WARNING: invalid pair index entry u'keyword; ' --- Got: /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/autodoc_fodder.py:docstring of autodoc_fodder.MarkupError:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/images.txt:9: WARNING: image file not readable: foo.png /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/images.txt:23: WARNING: nonlocal image URI found: http://www.python.org/logo.png /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/includes.txt:: WARNING: Encoding 'utf-8-sig' used for reading included file u'wrongenc.inc' seems to be wrong, try giving an :encoding: option None:4: WARNING: download file not readable: nonexisting.png /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/objects.txt:97: WARNING: using old C markup; please migrate to new-style markup (e.g. c:function instead of cfunction), see http://sphinx.pocoo.org/domains.html /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/images.txt:20: WARNING: no matching candidate for image URI u'foo.*' /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/markup.txt:: WARNING: invalid index entry u'' /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/markup.txt:: WARNING: invalid pair index entry u'' /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/root/markup.txt:: WARNING: invalid pair index entry u'keyword; ' ) -- Traceback (most recent call last): File /usr/lib/pymodules/python2.6/nose/loader.py, line 224, in generate for test in g(): File /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/util.py, line 177, in deco for item in func(app, *args2, **kwargs2): File /home/chl/Packages/PythonSphinx/Sphinx-1.0.8/tests/test_build_html.py, line 313, in test_html '--- Got:\n' + html_warnings AssertionError: Warnings don't match: --- Expected (regex): \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/autodoc_fodder.py:docstring of autodoc_fodder\.MarkupError:2: WARNING: Explicit markup ends without a blank line; unexpected unindent\.\n? \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/images.txt:9: WARNING: image file not readable: foo.png \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/images.txt:23: WARNING: nonlocal image URI found: http://www.python.org/logo.png \/home\/chl\/Packages\/PythonSphinx\/Sphinx\-1\.0\.8\/tests\/root/includes.txt:\d*: WARNING: Encoding 'utf-8-sig' used for reading included file u'.*?wrongenc.inc' seems to be wrong, try giving an :encoding: option\n?
Re: [sphinx-dev] Strange behaviour of :abbr:
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 23.09.2011 09:31, schrieb Stefano David: Hi, I started using sphinx around six months ago and find it easy to use and powerful. I found, however, a problem when using :abbr:and I do not know whether it is a bug or something I am missing. So, here's the point: Whenever I write, say :abbr:`SSH (Secure SHell)`, no problem, it works perfectly and creates a nice HTML tooltip. Problems start when e.g., the terms between braces are split on two lines, i.e., :abbr:`SSH (Secure SHell)` In this case, indeed, no tooltip is generated, but the whole expression (i.e., SSH (Secure SHell)) is printed as normal text, like I didn't use :abbr: As I am using even rather long abbreviations, it is likely that expressions are written on two lines, not generating the tooltip. I solved the problem by putting all :abbr: in an external file and including it in the files, so not a big problem, but wonder whether this is a bug or it is a problem with my installation/package or whatever. I use sphinx 1.0.7 (but same happened with 0.6.6) on debian and ubuntu and emacs 22, if this may help. The problem is reproducible even with two lines of text in an otherwise empty index.rst file, while any other directive works flawless, even e.g., :menuselection: which sometimes may become pretty long and complex. You're right, this was a bug in the regex I used. It's now fixed and will be released in 1.0.8 pretty soon. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk58RhUACgkQN9GcIYhpnLBmyQCgikUSC8OZBhdrBFVUTCgySCOc S/IAnA2NE3O7zUJb7XLexE6TpEb4ElVv =DZoV -END PGP SIGNATURE- -- 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] How do I add a cross-reference to js:attribute::
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 31.08.2011 11:05, schrieb Frank Schröder: Hi, I have a list of js:attribute:: entries and I would like to cross-reference them within the same document. How do I do this? Something similar to this (which does not work for me). I'm using Sphinx 1.0.7 if that is important. .. js:attribute:: FOO This does something .. js:attribute:: BAR This does something else. See :ref:`FOO` for details. Hi Frank, :js:attr:`FOO` should work. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk58R+oACgkQN9GcIYhpnLA4qQCgigp/UokzchRcxEYCDmpfLCTQ UKMAnjHmLzKqWGTUkUyIw4bz813s67RT =h+EZ -END PGP SIGNATURE- -- 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] Sphinx 1.0.8 released
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.0.8, a bug-fix release in the 1.0 series, fixing a large number of bugs in the 1.0 line of releases. The full changelog is at http://sphinx.pocoo.org/changes.html. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files). Website: http://sphinx.pocoo.org/ cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk585ugACgkQN9GcIYhpnLAjIQCfZYC6T9Tou6f+v6rP9ifIWBr/ RV0An1DKqscoqD7/dz49dhgflQyln+iX =Oey1 -END PGP SIGNATURE- -- 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: Images and re-builds
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 31.08.2011 21:24, schrieb Aivar: Hi! This quirk causes problems for me as well. I use Sphinx for generating course materials, where I occasionally update a chapter, rebuild and upload corresponding html file to the course site. Usually I forget to also upload those new copies of picture files and so I get broken image references in the html. Why does Sphinx work like that? Is there an option for turning off this behaviour? But in general, I'm extremely happy that I discovered Sphinx! Many thanks for the authors! Hi all, this annoying bug has now been fixed -- it was a simple typo in a utility module :) cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk57LagACgkQN9GcIYhpnLAI4gCfa4hrbOy8kczzTtpWJdCz5jGq nLYAnRWaVIBZ6aJn5uBJBtcYS+kAJth5 =s2+f -END PGP SIGNATURE- -- 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] New extensions : word writer clearquest directive
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.09.2011 15:09, schrieb Robin Jarry: Hello everyone, I've been using RST for over a year now and I wrote a couple of things around it. I don't know how I managed to miss the Sphinx project but hey, nobody's perfect :-) I would like to propose the integration of new extensions to sphinx- contrib: rst2word: https://github.com/robin-jarry/rst2word A writer to produce word documents from rst source. For now it only works with Word 2010 and supports only simple rst markup and constructs. I also added the possibility to export the document to PDF (native Word 2007+ functionality). I wrote it directly using docutils extension interface (Writer). I didn't look precisely how to integrate this to sphinx (apparently it's needed to extend the Builder interface) but it should be doable :) clearquest2rst: https://github.com/robin-jarry/clearquest2rst A docutils directive for converting ClearQuest requests to RST tables. Should be easy to integrate into sphinx. I hope you'll find interest in these :-) Hi Robin, to integrate these, it would be best if you tell me your bitbucket name and I'll give you access to sphinx-contrib. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk55qLAACgkQN9GcIYhpnLDhjgCfajQ9ye/kBiVhASUR6TeLmO2C wfoAnRzUKMBvTEOc8cMBtl95hg2xsFwz =HrC0 -END PGP SIGNATURE- -- 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] Estonian translation
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.09.2011 10:09, schrieb Aivar: Hi! I translated UI strings to Estonian (locale code 'et'). http://www.aivarannamaa.ee/sphinx/sphinx.po Hopefully this can be added to next release. Thank you! Please add it to a tracker issue, so that this doesn't get lost. What's the best way for generating sphinx.js file? You don't need to: that is done by the build process. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) iEYEARECAAYFAk524MQACgkQN9GcIYhpnLDTKgCePQUsbhv4NlCUcXZW1kAcLhU4 he8AnRpRjGEcjIg/kiLShvkgCg3mTn/v =t2v5 -END PGP SIGNATURE- -- 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] Release of 1.1: any plans?
On 22.06.2011 22:00, Roberto Bagnara wrote: On 06/22/11 21:57, Georg Brandl wrote: On 22.06.2011 21:50, Roberto Bagnara wrote: On 02/28/11 20:09, Georg Brandl wrote: On 28.02.2011 19:41, Prof. Roberto Bagnara wrote: Has this been planned? I am looking forward to the possibility of having multiple terms per entry in a glossary. Unfortunately, I currently was and still am quite busy (as you also can see from my lack of responses to this list). But Python 3.2 (where I am release manager) is now out of the door, and next weekend Python's switch to Mercurial should also be done, so I will hopefully have time enough to sort through all new bug reports and messages in sphinx-dev, and make progress towards 1.1 final. Hi Georg, any news when the release might be? I honestly don't know. I don't want to promise things anymore... so I guess I'll have to adopt the Debian motto it's done when it's done. OK, thanks. Would it be possible/sensible to use the version under development? It's certainly possible; most of the features that have been added won't change anymore. The release mostly hangs upon the completion of the i18n and web projects, and the addition of a few more features I had planned (although they can probably wait for subsequent versions). Georg -- 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] Release of 1.1: any plans?
On 28.02.2011 19:41, Prof. Roberto Bagnara wrote: Has this been planned? I am looking forward to the possibility of having multiple terms per entry in a glossary. Unfortunately, I currently was and still am quite busy (as you also can see from my lack of responses to this list). But Python 3.2 (where I am release manager) is now out of the door, and next weekend Python's switch to Mercurial should also be done, so I will hopefully have time enough to sort through all new bug reports and messages in sphinx-dev, and make progress towards 1.1 final. cheers, Georg -- 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] automodule/autodoc line numbers impossible to interpret
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 24.01.2011 20:24, schrieb Erik Tollerud: I've been making quite a bit of use of autodoc (specifically, automodule) for documenting a project. However, as the project has grown, I find it's difficult to tell where warnings are occurring in the source code, because the line numbers the Sphinx warnings output seem to be unrelated to the line numbers in the source documentation. Presumably this is because autodoc produces some kind of internal line- numbering scheme... is there any way to map the autodoc line numbers that the sphinx warnings emit to the actual source code line numbers? Or a way to output intermediate files that match the line numbers that can be cross-matched to the source code? Hmm, which version of both docutils and Sphinx are you using? I recently fixed a bug in generating line numbers in 1.0.7, and recent docutils versions also improved keeping track of not only source files but line numbers. Basically you should get location info such as docstring of OBJECT:line in that docstring. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk09zggACgkQN9GcIYhpnLDAagCfbGmFprd9S9Hsz0i8SsNKtGrW m8oAn10xKV3AUtvcw54Vfal3hY7MsrYt =973p -END PGP SIGNATURE- -- 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] How does sphinx auto-generate nightly docs?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 24.01.2011 20:13, schrieb Erik Tollerud: I've noticed the sphinx latest documentation page seems to stay in sync with the development version on bitbucket. Is this done by an automatic tool to keep the documentation page up-to-date with the latest mercurial commits, or is the page manually uploaded at regular intervals? And if the sphinx page isn't automatic, is there a tool out there to do this automatically? It's generated manually whenever I feel like it (usually after a substantial update). It's basically just a script that does hg update; cd docs; ../sphinx-build.py . /web/server/root. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk09zi0ACgkQN9GcIYhpnLA+zgCgl29IKt4kvTqR4YEsb0I4BwoT LO0AnRpUubca45lqMiVHZNEM2Z3nbvz7 =KnDC -END PGP SIGNATURE- -- 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] productionlist/latex problem (regression I think)
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.01.2011 15:47, schrieb Marcin Wojdyr: Yes, it was indeed. Should now be fixed with rev 70f2984f86d7. Thanks, the references work now. Is it possible to somehow switch off latex_show_pagerefs only for productionlists? Grammar rules with page numbers don't look good, but in other places pagerefs are very useful. Right. :) I think nobody will object to switch them off in production lists. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk011vYACgkQN9GcIYhpnLAE6QCeLacyS3Soxl/p5PUUPvZOkYTb ySEAnAzL+j3Xhw9wOF+vnMarjQYzkHhc =Sx82 -END PGP SIGNATURE- -- 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] Using Sphinx in education
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 22:12, schrieb Tim Bower: This is not exactly a new project using Sphinx, but I wanted to mention that I have been using Sphinx for course material delivery in college classes. I think Sphinx has a great deal of value to education as instructional technology. I just wrote and presented a conference paper about it. The title of the paper is Dumping PowerPoint in Favor of Web Sites. You may download the paper at: http://www.sal.ksu.edu/faculty/tim/scholarship/study_guides.pdf The notes that I used in the presentation may be viewed at: http://www.sal.ksu.edu/faculty/tim/prof-day/index.html Hi Tim, this is very nice to see! cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0yq50ACgkQN9GcIYhpnLAm8QCfZPD6WysepUwsQB7pf61nxd49 oYIAn3d8rQvhb9P1FOakyxnXKheRuWja =SgAh -END PGP SIGNATURE- -- 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] Intersphinx problem with Generator
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 16.01.2011 12:47, schrieb cool-RR: Hello, I write :term:`generator` in my docs, and do `make html`, but it doesn't make a link to Python's documentation. I also tried prefixing it with :py, doesn't help. Does Intersphinx not support terms? Thanks, Ram. I also tried :py:keyword:`yield` now, and it doesn't link either. You'll have to link to the development Python docs (http://docs.python.org/dev), since the 2.7 docs are still using Sphinx 0.6 which only can reference to Python objects, not terms or keywords. cheers, Georg I see. Do you think there's a good reason for them to stay at 0.6? Should I file an issue for them to upgrade? Since these branches are in bugfix-only mode, I thought it best not to update the toolchain either. However I'll discuss with the other developers for the next release. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0y6x0ACgkQN9GcIYhpnLBMfgCfYuMP0BbHqXjKTKfj2oruxME6 sLcAn2DMAL6+z1W1L9TZouin6sy+CBqj =8UHe -END PGP SIGNATURE- -- 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: Using Sphinx with C extensions
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 13.01.2011 09:12, schrieb Jason: On Jan 13, 3:33 pm, Georg Brandl ge...@python.org wrote: Is there any way around this? Yes: build the C extension before you build the docs. I use distutils to build it all, which deposits everything in a variably named build/lib.linux-ARCH-PYVERSION dir. I've searched the Sphinx docs for info on distutils integration, and the distutils docs for Sphinx integration, but with no luck. Do you have any pointers on how I can get distutils to invoke the Sphinx builder with the right sys.path settings every time? Sphinx does include a setup.py build_docs command, but it does not handling adding the distutils build directories to sys.path. It would probably a good idea to do this -- would you like to work on a patch? What I usually do is to copy the built C modules to the source path in my make the docs step: cp build/lib.*/_module.so src/package cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xZQUACgkQN9GcIYhpnLDupwCfd6bvaiaIkNEqjSAHcUJ41J8R KOgAnRL65preAFeAI6Evw1K+mCZT2sIt =sB6c -END PGP SIGNATURE- -- 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] classes inside automodule
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 14.01.2011 09:59, schrieb Chris Withers: On 14/01/2011 03:58, TP wrote: If I do, for example: .. automodule:: testfixtures .. class:: Comparison ...then I end up with two sections for the Comparison class, one auto-generated and one with my manual bits. I thought the manual one was supposed to override the automated one? I don't think so. This paragraph implies it should be possible: It’s possible to override the signature for explicitly documented callable objects (functions, methods, classes) with the regular syntax that will override the signature gained from introspection: .. autoclass:: Noodle(type) .. automethod:: eat(persona) This is useful if the signature from the method is hidden by a decorator. New in version 0.4. No, since your class is not explicitly autodocumented, but implicitly (by the members option). Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xZlgACgkQN9GcIYhpnLC0qQCfT5ZbPApMkx4H8rJBzVJh6X/3 5doAnRo9IO/8oeAddl/rLCdXyCvfHM6G =mOff -END PGP SIGNATURE- -- 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] Add Sphinx project
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 13.01.2011 15:51, schrieb Andy Harrington: The Python 3.1 versio of my Hands-on Python Tutorial uses Sphinx for both the html and pdf versions. http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/ http://anh.cs.luc.edu/python/hands-on/3.1/Hands-onPythonTutorial.pdf Feel free to add to your project list. Thanks, I've done so! Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xZqIACgkQN9GcIYhpnLDsjgCdF0gVnVDH9O0TIPlbwxhzjdgl 8ogAoK0Y2kvPFWR9L9gIN9FFGkOGcicm =btAS -END PGP SIGNATURE- -- 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] Projects using Sphinx
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 15:55, schrieb SHIBUKAWA Yoshiki: Hi, Many Sphinx sites in Japan are listed at the following page. http://sphinx-users.jp/example.html And I wrote 3 books with Sphinx(sorry, all of them are Japanese). 1. Simple and Steady Way of Learning for Software Engineering http://www.amazon.co.jp/dp/477414259X 2. Expert Python Programming (Japanese Translation) http://www.amazon.co.jp/dp/4048686291/ 3. Pomodoro Technique Illustrated (Japanese Translation) http://www.amazon.co.jp/dp/4048689525/ And I am translating The Art of Community into Japanese with Sphinx. Heh, no need at all to apologize for Japanese :) Thanks for the links! Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xZ2MACgkQN9GcIYhpnLA4FgCfQ+izJ0Lx1kI6LlyNxFZMWZ1C oF4AnRizuuFiSH221Rp4YLeyP38iwAmy =dTSE -END PGP SIGNATURE- -- 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] Projects using Sphinx
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 15:19, schrieb Jan Ulrich Hasecke: Hi, you may want to add two projects to the page: Projects using Sphinx Plone 4 Benutzerhandbuch (German) http://www.hasecke.com/plone-benutzerhandbuch/4.0/ and a non-software project: Das Realismuskonzept in Krzysztof Kie[lowskis DEKALOG. Filmwissenschaftliche Arbeit über die Fernsehserie Dekalog des polnischen Filmemachers Krzysztof Kie[lowski. (German) http://www.hasecke.eu/Dekalog/ Impressive, thanks! Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xZ2YACgkQN9GcIYhpnLAb3QCfWvhzkzSz8a6ey+ktLwFC+t5h Nl4An2QPsjQLvSNQ24Cbp8ofR/Mzc41Y =NW/s -END PGP SIGNATURE- -- 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] Projects using Sphinx
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 16:00, schrieb Enrique J. Hernández Blasco: Sorry for hijacking the thread. We also use sphinx in an open-source project called Zentyal. The documentation is available at: http://doc.zentyal.org It would be great to add this project to the project. I would be really appreciated. It is added. Nice color scheme, I like it! Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xZ58ACgkQN9GcIYhpnLDu1QCfQYP8shZ4RAC2msJY5ao5DYcl 94MAn37+VzFWb2S2laHiEfNDu5wkyv8T =KnhE -END PGP SIGNATURE- -- 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] Feature request with :lines: with :linenos:
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 16:23, schrieb Andy Harrington: I suggest/request that either the default or at least an option with .. literalinclude:: :lines: 10-15 :linenos: be that the line numbers are in sync with the lines. The code above is currently labeled with line numbers 1-6, not 10-15. That's a good request. I've added it in the tracker as #605. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xb2QACgkQN9GcIYhpnLDOUQCfV0bfVfsV8zrwczLnz45m+4yE xXgAn2nEqJuDL4N2/Fbz+wywCDrNL6Ie =StX8 -END PGP SIGNATURE- -- 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: Problem with mailto: links
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 22:45, schrieb Giles Thomas: Georg Brandl wrote: Thanks for the reply. We're using docutils 0.7 too; we're still on Python 2.5, though. Might that be the problem, do you think? Hmm, I don't think so. I'll have a closer look soon. Thanks! Let me know if you need any information to repro. OK, I indeed looked only at Firefox' status bar, which already unescaped the address. Reading RFCs 1738 and 2368, it looks to me like the escaping of characters in mailto: URIs is fully legal (and indeed required for characters such as % or linebreaks in addresses or headers). It seems to me that your mailing setup does not implement mailto: URIs correctly. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xcXkACgkQN9GcIYhpnLALtACeLm9iB+8mi0GwxOK1ZX6gzQP9 LXAAniShBy814ASzIo9Bsd/n9olVRaTN =Kp9C -END PGP SIGNATURE- -- 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] Sphinx 1.0.7 released
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.0.7, a bug-fix release in the 1.0 series, fixing a number of bugs in the 1.0 line of releases, most importantly a regression in LaTeX output introduced in 1.0.6. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files). Website: http://sphinx.pocoo.org/ What's new in 1.0 (very short version)? === Lots of stuff; most important of all domains support (see blog post at http://pythonic.pocoo.org/2009/9/12/new-in-sphinx-1-0-domains), new HTML themes, new output formats (manpage, epub). The full list is at http://sphinx.pocoo.org/latest/changes.html. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xvdYACgkQN9GcIYhpnLDP4QCfRl0Ns07BsYMyrCGffGk3b3ir TlkAnA/x82YNxd39PmwROoyiPrmr5qep =94qX -END PGP SIGNATURE- -- 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: :param: and :keyword: rendering
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 09:14, schrieb Guenter Milde: On 2011-01-11, Guenter Milde wrote: On 2011-01-09, Vinay Sajip wrote: If would be neater if instead of strongparam_name/strong, the output markup was something like span class=positional-paramparam_name/span and span class=keyword-paramparam_name/span ... I suggest emph or strong tags with class=parameter positional vs. class=parameter keyword so that even without a stylesheet the emphasis is kept (graceful degradation) but configuring the layout with CSS is easy. Using two class arguments (parameter keyword) instead of a hyphenated one (parameter-keyword) allows setting shared features in a common rule and diffentiating with the selectors .parameter.keyword vs. .parameter.positional. Addition: to avoid confusion with keywords of a programming language, I change my suggestion to strong class=parameter kwarg (i.e. kwarg instead of keyword). That sounds like a good compromise. I'll see what I can do :) Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk0tZjAACgkQN9GcIYhpnLBkLwCeJRB0/6Sw/zEbGGfCx3OFzCBX jDsAnjvPwnwz3GM0jXARKoTrMqQfOK6c =hwaE -END PGP SIGNATURE- -- 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: Why won't this code highlight?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 07:43, schrieb Kevin H: On Jan 12, 12:37 am, Kevin Horn kevin.h...@gmail.com wrote: here is a page of output from a sphinx project:http://twistedsphinx.funsize.net/projects/web/howto/resource-template... here is the source of that page:http://twistedsphinx.funsize.net/_sources/projects/web/howto/resource... Near the end is a file included using the literalinclude directive. As you can see it is not being highlighted, though I think it should be. It's just getting stuck in a pre tag. Every other literalinclude-ed file in this project works just fine. Things I have tried: * renaming the file from 'webquote.rtl' to webquote.py -- no change * using the ':language: python' option on the literalinclude directive -- no change * messing around with line endings -- no luck * messing around with html entity escaping -- no luck I can highlight this code with no problem using pygments' 'pygmentize' command line tool, so I don't think it's a problem with pygments. ??? Kevin Horn NEVERMIND! Apparently the process of writing my previous mail jogged my brain, because as soon as I'd sent it I found the problem. The code snippet is from the PTL template language (which comes with the Quixote web framework), which is almost (but not quite) valid Python. The problem is that PTL uses the keyword template rather than def when defining functions. I tried replacing the template keyword with def, and bang zoom, we have syntax highlighting. So now my question is: Why will Pygments highlight this from the command line app, but not in Sphinx? Python code is syntax-checked before highlighting, since it's the default highlight language, and this way you can put other code blocks in between without having to mark them as not-Python. For your case, try py3 as a highlighting language; it is not syntax-checked. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk0tZq0ACgkQN9GcIYhpnLBe9wCfQOcJQyVOcHf+Vzyx7pGohSk/ VWUAnRBtH2m46BFQ28jKttquelG9sZN8 =op0R -END PGP SIGNATURE- -- 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] Updating to new makefile
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 19:51, schrieb cool-RR: Thanks! Ram. On Tue, Jan 11, 2011 at 8:06 PM, DasIch dasdas...@googlemail.com mailto:dasdas...@googlemail.com wrote: There is no reason to update the makefile unless you want to use a new builder. In any case you can simply use sphinx-quickstart and copy the makefile, as long as you choose the same options for source and build directories. As a follow-up, I'll have a look into an option for sphinx-quickstart to only update the Makefile. (There's also an issue for it in the tracker.) Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk0tZvUACgkQN9GcIYhpnLBztQCfX+mOPubfeHXpXMj4W/ReG6Vn aE4AoJmeN4cM45XnegMyCcOn2GYZvRq0 =feQV -END PGP SIGNATURE- -- 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] productionlist/latex problem (regression I think)
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 11.01.2011 21:44, schrieb Marcin Wojdyr:
Hello,
I have such a thing:
.. productionlist::
line: [`statement`] [`comment`]
...
and if I use Sphinx 0.6.5 (from the python svn) to build latex, it
builds cleanly:
\begin{productionlist}
\production{line}{ {[}\token{\code{statement}}{]}
{[}\token{\code{comment}}{]}}
...
But with Sphinx 1.0.4 some undefined references get into the output:
\begin{productionlist}
\production{line}{
{[}{\hyperref[lang:grammar-token-statement]{\code{statement}}}{]}
{[}{\hyperref[lang:grammar-token-comment]{\code{comment}}}{]}}
...
Am I doing something wrong or is this a bug?
Sounds like it is a regression from removing old special cases.
I'll have a look.
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.11 (GNU/Linux)
iEYEARECAAYFAk0tZs4ACgkQN9GcIYhpnLDiMgCgsM6/uaaPU32wL4iPPud5NS3W
yggAoJDKldwRL6HMk3lrifKVi3SG5dfT
=gbao
-END PGP SIGNATURE-
--
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: Problem with mailto: links
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 10.01.2011 12:22, schrieb Giles Thomas: On Jan 7, 10:22 am, Georg Brandl ge...@python.org wrote: Am 03.11.2010 16:46, schrieb Giles Thomas: One oddity we encountered today was that mailto: links seem to be excessively escaped in HTML output. We are using something like this: `Send us an email mailto:supp...@projectdirigible.com`_ The Sphinx HTML output is: a class=reference external href=mailto:support %40projectdirigible.comSend us an email/a The escaped '@' doesn't seem to work very well in my browser/email client setup (Firefox/Google Toolbar to Gmail). Is this a bug, or are we just doing it wrong? this seems to be a bug in some docutils versions; it doesn't occur with docutils 0.7 here. Hi Georg, Thanks for the reply. We're using docutils 0.7 too; we're still on Python 2.5, though. Might that be the problem, do you think? Hmm, I don't think so. I'll have a closer look soon. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk0tZ0AACgkQN9GcIYhpnLBgNACcDkVlT3D5p1hsDlg2E8ELXSPi HTwAnjfMXBTMuLnrFAA9hwtXZou/+YxS =7ram -END PGP SIGNATURE- -- 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] autodoc and modules
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 09.01.2011 22:42, schrieb Vinay Sajip: Hi Georg, I'm not sure how to fix this. Even if you could get Sphinx to import the contents of baz via foo, the __module__ attribute of classes and functions would be wrong, and therefore these wouldn't be documented if you don't give them explicitly as members. Maybe the solution would be a way to register module aliases, to say this module should be known as that module. Perhaps that would work. Would you like to work on a patch? On a slightly different but related note (about reusing existing documentation), when using a 3rd-party library under the hood (and perhaps exposing its functions selectively) I find the versionadded/versionchanged directives can be misleading. You have to rewrite the documentation omitting those directives, because they relate to the version of the library you're using rather than your own software. This is unfortunate, though it has not been too painful so far because the incidence of such cases has been small for me. But a long-term WIBNIF (Wouldn't It Be Nice IF) would be some scheme that allowed you to easily transform and/or redirect the documentation nodes for specific entities before they were rendered. That might require digging into the docutils level, though. There's already autodoc-process-docstring, which allows you to process the unparsed docstring before rendering; I could imagine a similar event emitted *after* parsing but before returning the nodes from the auto-directive. Anyway, thanks again for Sphinx - I love it! Thanks :) Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk0tZ9QACgkQN9GcIYhpnLChBwCfTLbAz15tPhsWmUJOR/gV0CBR GLwAn071KDE2D0PL5bRlY7RD6Oq1u/8T =SjBg -END PGP SIGNATURE- -- 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: :param: and :keyword: rendering
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 12.01.2011 12:36, schrieb Fred Drake:
On Wed, Jan 12, 2011 at 3:14 AM, Guenter Milde mi...@users.berlios.de wrote:
Addition: to avoid confusion with keywords of a programming language, I
change my suggestion to strong class=parameter kwarg
(i.e. kwarg instead of keyword).
If we look back at how the old \keyword{...} was used in the LaTeX
system, it was specifically to mark language keywords, not keyword
parameters.
Whether this was valuable over \code{...} is open to debate.
(\kwindex{...}, generating an index entry, was separate.)
It probably wasn't valuable; the equivalent :keyword:`foo` in Sphinx is
valuable since it generates a link to the keyword's definition in the
language reference.
cheers,
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.11 (GNU/Linux)
iEYEARECAAYFAk0t/pMACgkQN9GcIYhpnLCyRACeKQ+RmJtspB44MsFdzSjpMQlV
YjoAoI2Fs6sxmvBqIJqAOBHzax0QP+Hb
=Lfru
-END PGP SIGNATURE-
--
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] Using Sphinx with C extensions
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 13.01.2011 05:05, schrieb Jason: I have written a Python module including a submodule written in C: the module itself is called foo and the C part is foo._bar. The structure looks like: src/ foo/__init__.py - contains the public stuff foo/_bar/bar.c - the extension foo/__init__.py imports _bar to augment it, and the useful stuff is exposed in the foo module. This works fine when it's built, but obviously won't work in uncompiled form, since _bar doesn't exist until it's built. So my question is: can I use the Sphinx autodoc module with it? I've added src to my sys.path (in conf.py) and have this stanza in index.rst: .. automodule:: foo :members: :undoc-members: ...but when I try to build the docs, I get: /path/to/project/doc/index.rst:14: (WARNING/2) autodoc can't import/ find module 'foo', it reported error: No module named _bar, please check your spelling and sys.path Is there any way around this? Yes: build the C extension before you build the docs. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk0uqt4ACgkQN9GcIYhpnLAv4ACeMxRHxvQ+Hv11f5EfIkDgbRWU gBgAn2FxwmgoOuikFvw+Jctk72P/CpXc =HT4t -END PGP SIGNATURE- -- 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] Setting the depth of the sidebar TOC
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Are you sure you put :tocdepth: 2 at the *top* of the *file*? Georg Am 10.01.2011 17:20, schrieb Eric Gilmore: Georg, I tried that, and it only affected the TOC tree in the index page -- not the side bar. *Should* that setting affect the side bar as well, and there is something wrong with my setup? The stickysidebar setting does basically solve my problem of long parameters spilling over. But I'm still curious about controlling the depth of the side bar. Thanks very much for your attention to my message :) On Sat, Jan 8, 2011 at 3:37 PM, Georg Brandl ge...@python.org mailto:ge...@python.org wrote: Am 23.12.2010 19:40, schrieb Gilmorez: It is very easy to set the depth of the TOC on an index page, and that is very handy. So far, in my attempts to figure out how to do the same for the sidebar TOC, I'm finding it difficult. We are using localtoc, and I would like to limit it to two levels so that long parameter and class names in our documentation do not appear there and spill over into the main frame. If anyone can point me in the right direction on how to control that, it is much much appreciated. You can do this by putting this at the top of the file: :tocdepth: 2 cheers, Georg - -- 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. -- *Eric Gilmore * Consulting Technical Writer Riptano, Inc. Ph: 510 684 9786 (cell) -- 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. -BEGIN PGP SIGNATURE- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk0rXP4ACgkQN9GcIYhpnLBn7wCeJZ0Wh9x36xtXnyD0jtlZiec+ kPMAoJKsPxpm+K4kf9+8Z/GOcTmEKMgj =bOTT -END PGP SIGNATURE- -- 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] Stripping module info in crossref
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Are you sure the function is correctly documented? If it is, :func:`.funcname` should definitely work (at least with Sphinx 1.0 and higher). Georg Am 08.01.2011 08:37, schrieb D. M. Monarres: Thank you for the help. It is still not picking it up unless I write out the entire function's name. I was just figuring that it was something easy that I missed. Sphinx is still great though, thanks for all of the hard work. -- D. M. Monarres dmmonar...@gmail.com mailto:dmmonar...@gmail.com On Fri, Jan 7, 2011 at 2:27 AM, Georg Brandl ge...@python.org mailto:ge...@python.org wrote: Am 07.01.2011 07:39, schrieb D. Monarres: Hello all, Right now I am trying to write a tutorial for the Sage computer algebra system that heavily cross-references with the standard documentation. Sage loads almost all functions/classes into the default namespace so most users know nothing of the module structure of program. I was wondering if there would be anyway to strip the module info from the :py:*:` ` directive. For example, the user only knows about a function named var(), but the real name of this function in sage is sage.symbolic.ring.var(). Is there anyway I can link to the right place without having the user see the sage.symbolic.ring portion? The target audience knows very little about python but I would like to be able to point to the additional examples in the standard reference. If there is no ambiguity, you can reference the function as :func:`.var` It will display as var and link to the sage.symbolic.ring.var target. If there is an ambiguity, you will get a warning stating that fact. ps. is there also a way I can have the external crossrefs open in a new window? Not by default, no -- mandating the opening of links in a new windows is usually frowned upon nowadays. Georg - -- 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. -- 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. -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0opbsACgkQN9GcIYhpnLDlBACgoHY1vBOUFSR8J4cxT0Tlavh9 iXEAoIiWJfmq9VQT2df3sXYjeY3S/oSb =osVO -END PGP SIGNATURE- -- 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 functions declared with lambda or returned from higher order functions
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 FWIW, Sphinx trunk now picks up a signature from the first line of the docstring, if it finds one. Georg Am 09.04.2010 17:26, schrieb Michael Rule: I would be happy even with a variety of hacks : most of these functions are one-liners. Is there some way to just post the function definition in the documentation ? Either in the object title or in the documentation below ? I can do this by hand but then the documentation does not automatically track changes in the code. Any ideas ? --mrule On Thu, Apr 8, 2010 at 9:17 PM, Michael Rule mrule7...@gmail.com wrote: Something like 80% of this library I am trying to document isn't declared with the traditional def syntax. I've figured out that Sphinx can produce reasonable documentation if I include a triple-quote string after the function declaration, but its not picking up arguments properly. Is there some way to the nice foo(a,b) format you get with def for functions declared as lambda functions ? You could even guess curried functions, if foo = lambda x:lambday:x+y then you could output foo(x)(y) in the documentation. Anyway, does anyone have any good ideas besides re-writing the entire library with def notation ? --mrule -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0oppcACgkQN9GcIYhpnLBUXgCff/56nKqDcApbcIfgJcoXa6Qc AQ4AoIJ7SPzCTLHDEi7RCePSRfE5xK/g =YvF0 -END PGP SIGNATURE- -- 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] [PATCH] add option pngmath_use_tooltips UPDATE
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 15.06.2010 22:54, schrieb Herbert Griebel: Unfortunately there was a missing format parameter in the code, here is an update with the fix. On 13.06.2010 20:45, Herbert Griebel wrote: add option pngmath_use_tooltips This option will show the formula in the tooltips if enabled, default is True. Thanks! This is now included in trunk (as pngmath_add_tooltips). cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0oqEcACgkQN9GcIYhpnLA+8QCdGfPvYKZyXJg7+GK/uoPQwSHV JPgAniIOeLAm2lwyW77HboPxCM8jciXE =afHm -END PGP SIGNATURE- -- 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] Autodoc munging \n in function signatures
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 19.03.2010 20:12, schrieb Jeff Forcier: Hi, and thanks for Sphinx! It's great. I've encountered what seems like an odd problem with the autodoc plugin: a function signature with \n in a default value has the '\' stripped away, and thus any generated autodocs appear to claim that the string instead just reads n. This happens regardless of whether the string is *just* \n or contains other text as well; it does *not* happen for e.g. \k; and it works correctly if the string is a raw string (r\n). (Except, of course, that now the default value is a literal \n instead of a newline -- which is incorrect.) It could be worked around by manually specifying the function signature in the .rst document that calls autodoc, but that's undesirable as it breaks DRY. Is this a bug? I haven't found anything in the Bitbucket issues that appears to correlate with it. I can file a new ticket if desired, but wanted to check beforehand in case I'm missing something stupid. Hi, while this was somewhat fixed in Sphinx 1.0, I've just fixed another bug that caused backslashes to be incorrectly stripped from signatures. This will be in Sphinx 1.0.7. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o1OYACgkQN9GcIYhpnLApzwCfZSWVCyZF/DJETKa94gVkFyyA f1UAnRasE3xROwt0Yd5OqOy12xI4Xbfr =pZe4 -END PGP SIGNATURE- -- 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: bibtex with autodoc
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 21.03.2010 21:44, schrieb Tim Michelsen: I was trying to use http://code.google.com/p/bibstuff/ to create rest- formatted bibliography from bibtex. It is able to scan rest file for references in source ReST files, but as I use autodoc, many references are (or will be) hidden in classes' docstrings, not appearing in sources directly. This topic pops up once in a while... Never got finally solved. What would be the recommended approach here? Someone has encountered this scenario? I did a first attempt here: http://bitbucket.org/birkenfeld/sphinx/issue/63/make-sphinx-read-bibtex-files-for Use the minimal emaple in the ZIP archive. Would you be interested in making this a package in sphinx-contrib? Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o1qoACgkQN9GcIYhpnLBMBwCgh5ZeNQibN/+EySpUKQj79j1/ OycAoJGuoSceV6W4dWokTp46v0JH76Qc =JLre -END PGP SIGNATURE- -- 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] ctypes, alias instead of __doc__
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 26.04.2010 22:22, schrieb Roger Binns: I have this in my module, setting up something for a callback: LOGCB=ctypes.CFUNCTYPE(None, ctypes.c_char_p, ctypes.c_void_p) LOGCB.__doc__=Create LOGCB(your_py_func) and pass ... However the generated doc (automodule) says this: LOGCB alias of CFunctionType How do I convince sphinx to use the doc instead wherever it dug that alias nonsense from? The doc string really is set. import module module.LOGCB.__doc__ Create LOGCB(your_py_func) and pass ... The problem here is that LOGCB.__name__ is still CFunctionType, why ever. If you set LOGCB.__name__ = 'LOGCB' it is documented correctly. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o2BQACgkQN9GcIYhpnLA+BACfQhwhwXBW7JAjxJxznJ/nDsTq ub0An2zG86szGr5Sibxmh3Hi1ZeIB10C =v+GN -END PGP SIGNATURE- -- 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] ctypes, alias instead of __doc__
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 08.01.2011 23:20, schrieb Roger Binns: On 01/08/2011 01:33 PM, Georg Brandl wrote: The problem here is that LOGCB.__name__ is still CFunctionType, why ever. If you set LOGCB.__name__ = 'LOGCB' it is documented correctly. Thanks. Making that change did indeed fix the problem. It would probably be helpful to have a little flowchart in the doc explaining how the doc is found. I just assumed that for each thing __doc__ is looked at, whereas there are other steps such as checking __name__. Yeah, it's sometimes very tricky to find out what exactly is going on, mostly due to Python's dynamic nature. In this case, classes that are just assigned to other names in other modules or classes are documented as aliases. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o5CEACgkQN9GcIYhpnLCZGACgiQX4utrfPFEk/5nhbUwcfbig tVAAn1BDU/azGf632OcbBmjddEFveSKy =UohD -END PGP SIGNATURE- -- 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] how to include a class attribute in docs
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 27.04.2010 16:16, schrieb Robert Cimrman: Hi, I have a large number of classes that look like: class MyClass(object): A docstring name = 'a string' Is it possible somehow to include automatically the contents of the 'name' class attribute into the documentation of the class? There can be many such classes in several modulel, which in turn are documented using .. automodule:: my.module :members: :undoc-members: - so the classes are collected automatically by autodoc. I have found autodoc-process-docstring which looks like it might be of some help, but do not know how to use it. Hi Robert, I've just made a change in Sphinx trunk that class attribute values are now displayed by default in trunk, and undocumented ones are picked up when undoc-members is in effect. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o6WcACgkQN9GcIYhpnLBXDwCdEfX3pLy/+nv5dYSaQp0lCeM9 Zq8An2pss3iBRM0cFW4OAhG5/EZRox3C =C8DH -END PGP SIGNATURE- -- 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] Documenting inherited members selectively
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 17.10.2010 20:36, schrieb Vinay Sajip: Is there a way of documenting inherited members selectively? Say I have a class which inherits from another class as an implementation detail. I want to document only certain inherited members. Hence: class Base(object): def member_A(self): pass def member_B(self): pass def member_C_low_level_detail(self): pass class Derived(Base): def member_D(self): pass Now, I'd like to do .. autoclass:: Derived :members: member_A, member_B, member_D :inherited-members: and have it only pick up those members named in :members: - but that doesn't seem to be happening, and I get all inherited members. Is it meant to work like this? In practice there are a lot more members in the base class, and I only want to expose some of them in the docs. Hi Vinay, if you list members explicitly, there's no need to give :inherited-members: at all. I've just updated the documentation to clarify this, since it was not documented that way. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o6i4ACgkQN9GcIYhpnLBkcQCfc2JzDyXgabJ9chtAnk7gKlQU oXkAn0WtmjubSIU/vhfsJTY73yFEBE/d =N3Ot -END PGP SIGNATURE- -- 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] autodoc and modules
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 19.10.2010 11:19, schrieb Vinay Sajip: I have the following simple code structure: code/ foo/ __init__.py from bar import baz from bar.baz import Baz bar/ __init__.py baz.py class Baz(object): This is the Baz class. pass The code directory is added to sys.path in conf.py. In my index.rst I have: .. autoclass:: bar.baz.Baz .. autoclass:: foo.Baz .. autoclass:: foo.baz.Baz Now the first two of these work as expected, but the last one fails with a no module named baz error, even though foo.baz is the Python module bar.baz because of the statement in foo/__init__.py which says from bar import baz. If in conf.py I put the lines import foo print bar.baz.Baz print foo.Baz print foo.baz.Baz then I get class 'bar.baz.Baz' printed thrice, as expected. But you can't do import foo.baz which is basically what Sphinx is trying to do. The reason I want to do this is, that foo's use of bar is effectively an implementation detail. I want to represent bar.baz as foo.baz, which I can't, though I can represent bar.baz.Baz as foo.Baz! Obviously there are workarounds, but why should they be needed? I'm not sure how to fix this. Even if you could get Sphinx to import the contents of baz via foo, the __module__ attribute of classes and functions would be wrong, and therefore these wouldn't be documented if you don't give them explicitly as members. Maybe the solution would be a way to register module aliases, to say this module should be known as that module. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o67cACgkQN9GcIYhpnLAn+wCdEureNZQBYV5OehhxwZ/wX4ks XyQAoIs5H69xGcJ8SOorvR7aaNt050q3 =SUKm -END PGP SIGNATURE- -- 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] :param: and :keyword: rendering
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 16.10.2010 21:41, schrieb Vinay Sajip: Is there an easy way to have these styled differently, so it's more obvious what the keyword parameters are? Especially when the method signature uses **kwargs. Is there a particular reason why the distinction is there? Is the fact that param, parameter, arg, argument, key, keyword are all offered just to accommodate the preferences of different users? Yes, and different names used by different documentation tools. If would be neater if instead of strongparam_name/strong, the output markup was something like span class=positional-paramparam_name/span and span class=keyword-paramparam_name/span They would still all be in one list, so how would you style them differently (without confusing the user)? Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o7SMACgkQN9GcIYhpnLDLBwCeJtekepWCk9AAsRl0ORo2gJDq PkkAnjCjYIWpPHNxctkpbeUNmlcUBWEp =9wHv -END PGP SIGNATURE- -- 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] custom internal hyperlinking roles -- resolving xrefs
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 14.12.2010 00:21, schrieb Václav Šmilauer:
Hello everybody,
I am struggling with a simple thing (but I want to do it properly)...
I want to create a custom internal hyperlinking role :yref:`target`,
where target is transformed to yield name of an existing label
(target2, created either manually or automatically) somewhere else in
the document (class name or such), so in the end it will be as if
writing :ref:`target target2`. This target2 should be then resolved
automatically.
So far, I do the following in conf.py:
1. I create a class inheriting from XRefRole, overriding process_link:
class YXRefRole(XRefRole):
def process_link(self, env, refnode, has_explicit_title, title,
target):
# the logic here would be more complex; for now, we want to
simulate :ref:`[[target]] prefix.target`
return '[['+title+']]','prefix.'+target
2. Then I create a thin wrapper function to use that class:
def yref_role(type,rawtext,text,lineno,inliner,options={},content=[]):
# I know this has to instantiate the class over and over, but that
is not an issue now
return YXRefRole()
('yref',rawtext,text,lineno,inliner,options,content)
3. Finally, the role is registered:
from docutils.parsers.rst import roles
roles.register_canonical_role('yref', yref_role)
The result is that the title is really replaced (I see [[target]] in
bold in the resulting HTML), but the hyperlink is not created and I
don't see any warning about unresolvable reference...
What is the last piece that I am missing?
You will have to tell Sphinx what role you want to replace: in yref_role,
call YXRefRole()('std:ref', ...) instead of ...'yref'...
You can also set these properties in process_link() and remove the
indirection via another role function. My suggestion:
from sphinx.roles import XRefRole
class YXRefRole(XRefRole):
def process_link(self, env, refnode, has_explicit_title, title, target):
refnode['reftype'] = 'ref'
refnode['refexplicit'] = True # to prevent that Sphinx overwrites
# the title you set
return '[['+title+']]','prefix.'+target
def setup(app):
app.add_role_to_domain('std', 'yref', YXRefRole())
cheers HTH,
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)
iEYEARECAAYFAk0o8H4ACgkQN9GcIYhpnLA7kACgqPB/h8Rpdu50bq5i/sEsq3jE
qaMAnjFO/FbT9i8gOonnwHTtnNFs5uLY
=Y77h
-END PGP SIGNATURE-
--
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] Feedback for first pass bibtex extension?
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 15.12.2010 21:41, schrieb Matthew Brett:
Hi,
I've been working for a few days on my first sphinx extension, an
attempt to allow us to include citations from bibtex files.
I wanted to ask for feedback about the design. In particular I hit a
couple of things that I wasn't sure about that I'd like advice on.
The extension is here:
https://github.com/matthew-brett/bibstuff/tree/master/sphinxext
and the code in particular is in the bibref.py file in that directory.
It's built on top of the bibstuff code by Dylan Schwilk and Alan
Isaac: http://pricklysoft.org/software/bibstuff.html. I had to modify
their code a little to get the extension to work, so the extension is
inside a modified copy of their code:
https://github.com/matthew-brett/bibstuff
From the bibstuff.py file docstring:
Implements two new directives::
.. biblisted:: myrefs.bib
:style: default
ref1
ref2
ref3
which results in the generation of 3 citation targets with the references
extracted from myrefs.bib and formatted according to the `default` style.
.. bibmissing:: myrefs.bib
:style: default
This directive takes no content, and watches for missing citations during the
build. If it has a citation for the missing reference, it inserts the citation
during build.
I'd be very grateful for feedback.
Looks great! I tested it and the test/doc test worked fine once I had
simpleparse installed.
I had two questions. The first is:
I wanted to insert new rst formatted code into the doctree, and the
way I did this, was put the code into a new in-memory document, and
pull the parsed nodes out of that, as in this function:
def rst2nodes(text, settings):
new_doc = new_document('temp-string', settings)
parser = Parser()
parser.parse(text, new_doc)
return new_doc.children
Is that the right way to do that task? Sorry if that's an ignorant
question...
Not at all. That is definitely one way. I see that one call is in a directive
function; there you could also call self.state.nested_parse(). But the other
being in the event handler, where no reST parser is available, I'd just keep
it that way.
Second question: for obvious reasons I found I wanted to handle the
missing-reference event, but the event parameters weren't enough to do
what I wanted. Specifically, what I needed to do with the missing
reference was (from sphinx/environment.py around 1343):
newnode = make_refnode(builder, fromdocname, docname,
labelid, contnode)
but, the missing-reference event only gives me::
missing-reference(app, env, node, contnode)
I can get the builder, and docname and labelid, and I've been passed
the contnode, but there does not appear to be a way to get the
'fromdocname' that I needed. I think that's the same as for this
post:
http://www.mail-archive.com/sphinx-dev@googlegroups.com/msg01895.html
Oh, indeed. Originally, missing-reference was designed for the intersphinx
extension, which doesn't need fromdocname since it returns an absolute URI
to another site.
I can fix this for 1.1 by adding more arguments to missing-reference, which
will be an incompatibility but a necessary one, since there aren't so many
uses for the missing-reference as it is now anyway.
In the end I resorted to this - hack:
def doctree_read(app, doctree):
Give each pending citation its docname
for pref in doctree.traverse(addnodes.pending_xref):
if pref['reftype'] != 'citation':
continue
pref['docname'] = app.env.docname
I wanted ask whether there is a better way to do this?
Unfortunately, this isn't perfectly correct either, since the fromdocname
isn't always the document in which the reference node occurs. This problem
occurs in builders that lump together nodes from multiple source files,
like the singlehtml builder.
Lastly, I noticed that the code still raises a warning that it didn't
find my citations, even when the missing-reference event returned a
citation, because of the code around 1340 in environment.py in my
version. Would you be interested in a patch to defer this warning
until after checking the missing-reference?
I've only recently refactored this code for Sphinx 1.1, and there the
warning shouldn't occur.
cheers,
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)
iEYEARECAAYFAk0o9REACgkQN9GcIYhpnLAI2ACfdIBxJFrrm3m1jzM+F7ic6DcN
b9sAnjzQkBsx046PDGVimtRdE207iKf9
=y/ut
-END PGP SIGNATURE-
--
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] little patch for autodoc
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 16.10.2010 22:00, schrieb Luc Saffre: Here is a little patch I suggest for autodoc. In :file:`sphinx/ext/autodoc.py` line 332 (meth:`Documenter.import.object`), add 2 lines:: except Exception, err: if self.env.app.warningiserror: # ADDED raise# ADDED self.directive.warn( 'autodoc can\'t import/find %s %r, it reported error: ' '%s, please check your spelling and sys.path' % (self.objtype, str(self.fullname), err)) return False This is about when a module you are autodocumenting fails to import. Sphinx's or autodoc's usual behaviour is to just issue a one-line warning. That's perfect. When sphinx-build was called with `-W` then the warning causes it to stop. That's also perfect. I just would like it to stop with a traceback and not with a single warning line. I've now implemented a similar change: the traceback is always shown, except if the quiet option is given to Sphinx. Also, documents containing auto-directives that fail on import are now always re-read on next build. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m2zAACgkQN9GcIYhpnLAbRACgkhnyWBsxb0bEBb76KT0KmHxH I50Anj0kr4wf3fct5hP/TeXh1B0DOYMK =AEV+ -END PGP SIGNATURE- -- 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] autodoc should tell which module caused an rst warning
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 16.10.2010 19:23, schrieb Luc Saffre: Hello, there is an annoying detail in autodoc: when I have some rst syntax warning in the docstring of one of my modules, then the output of sphinx-build doesn't indicate in which module the warning occured:: ... reading sources... [ 98%] topics/index reading sources... [ 99%] topics/svn reading sources... [100%] topics/templates autodoc:0: (WARNING/2) Bullet list ends without a blank line;\ unexpected unindent. looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 0%] about/index ... My project `Lino http://lino.saffre-rumma.ee`_ contains over 100 modules and I have no idea about how to find the culprit... This issue is of course not urgent, but if it isn't much work and somebody does it, I'd be glad to test it. FWIW, this should be fixed in 1.0.6. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m20MACgkQN9GcIYhpnLC0ugCdHQn5SWTdVKZBclzOMtLTjq5i tAAAnRfjvYGNaM/rZ/48t8L6IoKKx3hO =TOrk -END PGP SIGNATURE- -- 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] Howto autodoc utility script
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 26.11.2010 21:56, schrieb Johan Ekh: Hi all, I'm new to Python and Sphinx. I'm developing a small python module that contains some classes and methods. In parallel I develop some utility scripts that imports the module and use the functionality in the module. I let Sphinx extract all docstrings in the module RifPost with .. automodule:: RifPost :members: which works fine. But how can I extract the docstrings from my utility scripts? You can't do that with autodoc if they are not importable. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m26IACgkQN9GcIYhpnLBztACfVAbOJ9XAc8K4QTTOae/TospT h74AnArp1MH6ZSGMLDuX7TnkIoxI92OC =cFGr -END PGP SIGNATURE- -- 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] Patch request for node line numbering
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 24.08.2010 15:53, schrieb Kevin Dunn: Hi, I'm developing a Sphinx extension and Django application that I hope to publicly release soon. The extension allows for commenting on each node in the documentation. Docutils makes the starting line number available for each node in the RST file. However, the node's line number is not always propagated for some of the custom Sphinx nodes. It would helpful if the following small patches can be made to: * sphinx/directives/code.py * sphinx/directives/other.py * sphinx/ext/mathbase.py as given by the attached Mercurial diff output against the latest tip. These changes simply ensure that the line number, provided by Docutils via ``self.lineno``, are available in the node object when the various ``visit_ `` methods are called later on. The line numbers for most nodes are already available, but these few were not. This is now committed to 1.0 and trunk. Thanks, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m6C4ACgkQN9GcIYhpnLCrOwCglZ1D4vWTHxQLbV6TbDCE+GtU fQIAoK1l6ufNiRtlQGdbo8VGnYh1Ddkd =T91O -END PGP SIGNATURE- -- 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] Missleading error / warning output in class WarningStream (environment.py)
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 09.09.2010 13:28, schrieb Martin Brochhaus: Hello group, this is quite hard to explain and I don't understand the inner workings of the whole call stack that finally leads to a warning output when there are syntax errors in docstrings - but I think I found a way to reproduce this error. Create a python file with the following content: # -*- coding: utf-8 -*- class Foo(object): Foo. def foo_bar(self): Foo. Foo foo foo foo: id: UUID (str) text: Text (unicode) a_id: Antrags-ID (int) geloescht: Gelöscht-Flag (boolean) pass Try to run sphinx on it. Hopefully it will recognize a syntax error. I usually put a breakpoint at this line of code: http://bitbucket.org/birkenfeld/sphinx/src/f0b836f45d3e/sphinx/environment.py#cl-86 You will see that the variable text contains u'autodoc:0: (ERROR/ 3) Unexpected indentation.\n' which is quite useless. When you walk up the call stack to this line: http://bitbucket.org/birkenfeld/sphinx/src/f0b836f45d3e/sphinx/ext/autodoc.py#cl-128 you will see that the parameter **kwargs contains the correct line and source information. Any ideas what causes this behaviour? This was a bug where autodoc threw away correct source/line information even when it was already present. It should be fixed in 1.0.6. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m6HQACgkQN9GcIYhpnLD6rQCgqVHqNsJe1lsgedktNMcCD/uR tvoAn3vSqIwqSG/iAP3TYhP6nrx8Yjtq =pzzG -END PGP SIGNATURE- -- 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] Problem with mailto: links
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 03.11.2010 16:46, schrieb Giles Thomas: Hi there, We've been using Sphinx to put together the docs for a new project -- fantastic tool, many thanks for making it available! One oddity we encountered today was that mailto: links seem to be excessively escaped in HTML output. We are using something like this: `Send us an email mailto:supp...@projectdirigible.com`_ The Sphinx HTML output is: a class=reference external href=mailto:support %40projectdirigible.comSend us an email/a The escaped '@' doesn't seem to work very well in my browser/email client setup (Firefox/Google Toolbar to Gmail). Is this a bug, or are we just doing it wrong? Hi, this seems to be a bug in some docutils versions; it doesn't occur with docutils 0.7 here. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m6VAACgkQN9GcIYhpnLAk7wCfXRGNkZGj0dS8OCZ8c8UL+UQE q1AAoJV/RSSrmXVsASbzk4sqcu4gq0dM =GlMl -END PGP SIGNATURE- -- 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] Request to be included on the list of projects using Sphinx
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 09.11.2010 20:19, schrieb Giles Thomas: Hi all, We've now uploaded the first cut of our documentation for our (commercial) product using Sphinx -- thanks once again to the creators for such a brilliant project! The docs are here: http://projectdirigible.com/documentation/, and the main project page is here: http://projectdirigible.com/ -- we'd be very grateful if you'd add us to the list of projects using Sphinx. Dirigble is now added to the list. Thanks, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m6ZUACgkQN9GcIYhpnLBRcQCfTn8EqwaDsxkeaeLRVxi4FsqF E/oAn0dHTDOkjTzGj6Jet9b9MlSDHSSJ =MbAK -END PGP SIGNATURE- -- 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] download file missing
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 10.12.2010 07:22, schrieb monkut: I'm getting the following warning after change the name of ID_request.rng to something else. I've removed all :download: references to ID_request.rng from all my text source files, and removed (renamed) the file itself. However, after initally adding then changing the name and running sphinx 1.0.5 again I'm still getting this warning: WARNING: cannot copy downloadable file u'ID_request.rng': [Errno 2] No such file or directory: u'ID_request.rng' I've tried to delete the resulting .buildinfo file that is generated, thinking that some how it stored some info on previous files, but even after deleting this file and re-running sphinx I'm still seeing this warning. I've checked several times, and the source txt I'm running sphinx on, no longer contains the :download: reference and the output source files do not either. Is there somewhere else this information is stored that I need to clean out or is there something wrong with my setup? Hi, this is indeed a bug (a full rebuild gets rid of the warning). The bug is now fixed and will be part of Sphinx 1.0.7. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m6gMACgkQN9GcIYhpnLA+GACeLeWU1FuDH990rtcW80BsygXL KIEAmwR/6cW1Qoudfeq4IHT1/25hxARF =7TQ8 -END PGP SIGNATURE- -- 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] Stripping module info in crossref
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 07.01.2011 07:39, schrieb D. Monarres: Hello all, Right now I am trying to write a tutorial for the Sage computer algebra system that heavily cross-references with the standard documentation. Sage loads almost all functions/classes into the default namespace so most users know nothing of the module structure of program. I was wondering if there would be anyway to strip the module info from the :py:*:` ` directive. For example, the user only knows about a function named var(), but the real name of this function in sage is sage.symbolic.ring.var(). Is there anyway I can link to the right place without having the user see the sage.symbolic.ring portion? The target audience knows very little about python but I would like to be able to point to the additional examples in the standard reference. If there is no ambiguity, you can reference the function as :func:`.var` It will display as var and link to the sage.symbolic.ring.var target. If there is an ambiguity, you will get a warning stating that fact. ps. is there also a way I can have the external crossrefs open in a new window? Not by default, no -- mandating the opening of links in a new windows is usually frowned upon nowadays. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0m6n8ACgkQN9GcIYhpnLC6pgCgoonqxr8W5sati1ojUy4zuRT8 fK4AoIV9Hxgc2EIbFQ/sgcIK0x8xx6fU =r4mr -END PGP SIGNATURE- -- 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] proposed sphinx.ext.autodoc proposed change
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 02.04.2010 09:50, schrieb syt:
Hi there,
To be able to put more doc in code, I've developped a new simple
autodoc directive which basically add
a module docstring without anything else (eg no module 'signature', no
members).
This was quite easy, though to make it works properly, I had to monkey
patch AutoDirective.run method,
to turn the end of the method into:
if self.name in ('automodule', 'autodostring'): # XXX add my
custom directive name here
node = nodes.section()
# necessary so that the child nodes get the right source/line
set
node.document = self.state.document
nested_parse_with_titles(self.state, self.result, node)
else:
node = nodes.paragraph()
node.document = self.state.document
self.state.nested_parse(self.result, 0, node)
That could be avoid by putting this behaviour on the documenter
classes. Is it fine by you if I submit a patch for that?
Hi,
I've now added a `titles_allowed` attribute to Documenter that should
do what you suggested.
cheers,
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)
iEYEARECAAYFAk0nEE4ACgkQN9GcIYhpnLC/YQCgoKVXZTjK/UrPvCZezaTLstDA
oZQAoKk3VsIrcnrJ5Zn7W3PYozwmNDt2
=8w9h
-END PGP SIGNATURE-
--
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: Howto autodoc utility script
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 07.01.2011 14:11, schrieb Jakob Malm: On 7 Jan, 10:23, Georg Brandl ge...@python.org wrote: which works fine. But how can I extract the docstrings from my utility scripts? You can't do that with autodoc if they are not importable. If you organize your utility scripts like this you will at least be able to get the docstring for the module (file), and data defined: Docstring for the script. #: Some data that you want autodoc to catch SOME_SETTING = 1 if __name__ == '__main__': # Your code goes here... # but autodoc won't see it, since __name__ != '__main__' when the python file is imported. Yes; the only problem is that scripts often have names that aren't valid module names, and so cannot be imported, only directly executed. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0nEgIACgkQN9GcIYhpnLAOIACfbNN+2SyWJhr4XYINBb8hEDNT wJYAn1b+9EUP3IIBz7Ag7M/JtdYpN7Ql =gsYw -END PGP SIGNATURE- -- 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] Sphinx talk at PyCon 2011
Hi, this is just a short notice that there will be a talk about Sphinx at the US PyCon 2011, held by Brandon Craig Rhodes, formerly editor- in-chief of the Python Magazine: http://us.pycon.org/2011/schedule/sessions/219/ cheers, Georg signature.asc Description: OpenPGP digital signature
Re: [sphinx-dev] latexpdf Undefined control sequence. \MakeFramed
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 06.01.2011 03:51, schrieb steve:
I've been banging my head against this one too long now.. Just started
using sphinx yesterday... LOVE it! But... I just started incorporating
actual code snippets and while HTML output works OK, when I try to
build a .pdf with latexpdf I'm getting:
! Undefined control sequence.
recently read \MakeFramed
l.409 \begin{Verbatim}[commandchars=\\\{\}]
I've snooped around the email list and googled a bit with no hints.
Don't know enough of the plumbing to know where to look. What have I
spelled wrong?
Hi,
the \MakeFramed command comes from a package called framed.sty. Either
you should have another error message that this package cannot be found,
or your version is too old.
What you can do is to put the command
\listfiles
at the very top of the .tex file that is output by Sphinx. This will
output a list of used packages at the end of the pdflatex run (you will
have to press Enter when the error prompt is displayed, and not X.)
For example, on my machine this shows
framed.sty2007/10/04 v 0.95: framed or shaded text with page breaks
cheers,
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)
iEYEARECAAYFAk0le9wACgkQN9GcIYhpnLCizACeKRGEbNNgsWEGIgFWdnvc2+KM
dvAAn0/meDJOxGAASz/WznfcZUUojHVo
=3vbV
-END PGP SIGNATURE-
--
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] another code for the sphinx list
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 28.08.2010 00:18, schrieb j brandon keith: Hi, here is another code for the sphinx documentation list: http://docs.danse.us/pyre/sphinx/ Pyre is a service component framework. It also has a trac page at: http://dev.danse.us/trac/pyre. These are docs for version 0.8. We have a new version using sphinx trunk and python 3.x coming up... This is now in the examples list. Thanks, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0loU4ACgkQN9GcIYhpnLCkTwCcCulBaoduYytpnvXwoSJhKtnw l/4AoK2Fzz/XQWQj3h1h5nYeillSmpLt =xEn9 -END PGP SIGNATURE- -- 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] Yet another project using Sphinx
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 08.08.2010 20:40, schrieb Luc Saffre: Please add Lino to the list of projects using Sphinx: http://lino.saffre-rumma.ee/ This is now added. Thanks, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0loXYACgkQN9GcIYhpnLAvzACeOMY6SbcISbCDdK795aFWtk52 JksAn0a/ZrOFo+iepEH38VVt1mw4DNhc =VfVb -END PGP SIGNATURE- -- 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] Mishandling of C++ constant member functions
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 08.08.2010 21:57, schrieb Jack: I'm using Sphinx v1.0.1 and there does not appear to be a sane way to handle C++ const member functions. For example: .. cpp:class:: butterflyfio::ArrayT,d A simple template class for arrays of datatype ``T`` of length ``d``. .. cpp:function:: T operator[]( unsigned j ) Returns a modifiable reference to the ``j`` th index in the array. .. cpp:function:: const T operator[]( unsigned j ) const Returns an immutable reference to the ``j`` th index in the array. This is used when working with constant arrays. This incorrectly renders the last function with arguments ( unsigned j const ) rather than ( unsigned j ) const. If I remove the const at the end of const T operator[]( unsigned j ) const, then Sphinx crashes with the following output: Hi, both forms, with and without trailing const, should now work. The former already works in 1.0.6, while I just fixed the bug that caused the traceback with the latter. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0lp7oACgkQN9GcIYhpnLAoIQCgqEc+YrrDL9FPkPITj6XjwHo4 5ZMAn1IWlBdTB0dkN/jCB+KRDTvpKm+m =dN7o -END PGP SIGNATURE- -- 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] index directive followed by only directive crash latex and rst2pdf builders
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 06.05.2010 15:45, schrieb fgpy: Hi, When I try to `make latex`, I get the following error. Exception occurred: File C:\Python26\lib\site-packages\docutils\nodes.py, line 695, in replace_self 'Losing %s attribute: %s' % (att, self[att]) AssertionError: Losing ids attribute: ['index-120'] After a long series of tries, I nailed down the root of the issue as being the sequence of .. index and .. only directive. So the following does not work: .. index:: single: Menu Design; IMAGE .. only:: html :UserHelp: `IMAGE/EN ../../../../user/en/html/usage/image/ image.html`_ while the following does: .. index:: single: Menu Design; IMAGE .. a line of comment to separate the 2 .. only:: html :UserHelp: `IMAGE/EN ../../../../user/en/html/usage/image/ image.html`_ Knowing this, both latex and rst2pdf work fine now. Thanks for the report, this is now fixed with changeset 9cb18b252556. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0lrI8ACgkQN9GcIYhpnLBHhQCgplEVeNaeBouST/4i+95NGDwh W/YAnAz7Z1FFsX8OZCV9LKF5TAmIHmNi =CHy8 -END PGP SIGNATURE- -- 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: Any plans for sphinx.ext.mathjax?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 21.11.2010 21:50, schrieb Kevin Dunn: Hi everyone, Just to continue this thread, using MathJax in Sphinx is now even easier: FTR, I've just added Kevin's MathJax extension in trunk; it will be builtin in Sphinx 1.1. Thanks all! Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0ls/4ACgkQN9GcIYhpnLC/AACdH9VMrvMCJ7YUM68WjlcT094o DX0AnijqVjxJu1OSwMKpLoN9rrrT8Lz+ =hchi -END PGP SIGNATURE- -- 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: Question about Verbatim redefinition
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 09.12.2010 09:30, schrieb Lennart Regebro:
On Thu, Dec 9, 2010 at 07:48, Guenter Milde mi...@users.berlios.de wrote:
On 2010-12-08, Lennart Regebro wrote:
In sphinx.sty there is a redefinition of Verbatim. In that there is a line
\noindent\hspace*{-\leftsidespace}%
What does it do?
It sets the left margin/indentation.
If I keep that line in sphinx.sty, every single
literalinclude will produce the error:
Overfull \hbox (36.135pt too wide) in paragraph at lines 4898--4898
| []
This is not an error but a warning: the lines are too long.
No they aren't, and it's *always* 36.135pt's to wide, and from what I
can gather the error only happens on empty lines, but I'm unsure of
that, it could also be that it always happens on the end of the block.
If the output is OK, you can ignore these warnings.
Well, I removed the line above, as about half the log file was these warnings.
Without it: No errors. The output is as far as I can determine from
printing out two pages and comparing, *exactly* the same.
Compare the horizontal alignment/position of the literal block.
No difference at all. (No indentation at all, for that matter.)
Same for me. I've now removed these calculations. (The added effect is that
there now is consistently no indentation in literal blocks, while previously
blocks within lists were indented relative to the list item indentation.
Georg
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)
iEYEARECAAYFAk0l/ygACgkQN9GcIYhpnLBzRQCeMMwyI2F5hZEvOJVbD4FbbqH1
yLwAn3yYkdgilMLLwM8/l31QrskphuZ0
=NWCe
-END PGP SIGNATURE-
--
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] index directive prevents paragraph separation in LaTeX
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 07.10.2010 10:46, schrieb Markus Hubig: Hi @all, i'm fighting with a strage issue. If I put a .. index:: Bla- directive between two paragraphs the two paragraphs are later concatenated in the LaTeX output. FWIW, this should be fixed in Sphinx 1.0.6. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0knZIACgkQN9GcIYhpnLBAhwCgrZhPXGvveHYNuZGa1ZvEAZ+L I2AAnRwYgETeq0KmcrrkLF4gk1VMh/HD =wXuv -END PGP SIGNATURE- -- 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: Sphinx breaks with latest Docutils latex writer
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 14.11.2010 20:41, schrieb Guenter Milde: On 2010-11-11, dkuhlman wrote: I use Docutils from the SVN repository and Sphinx from the Mercurial repository. When building docs with make html, I got this exception: # === Exception occurred: File /home/dkuhlman/a1/Python/Sphinx/Hg/sphinx/sphinx/writers/ latex.py, line 105, in ExtBabel _ISO639_TO_BABEL = Babel._ISO639_TO_BABEL.copy() AttributeError: type object 'Babel' has no attribute '_ISO639_TO_BABEL' The full traceback has been saved in /tmp/sphinx-err-T6v6zQ.log, if you want to report the issue to the developers. # === Strange to find an exception in the latex writer with make html... It happens on import time. Apparently the name has changed in docutils/docutils/writers/latex2e/ __init__.py. I believe it changed from _ISO639_TO_BABEL to language_codes. But, I'm not too sure. This is correct. (There has been a major refactoring of the Babel class in connection with the adding of a XeTeX writer.) Has this already been picked up? Apparently not. It should work now with 1a6f1a9be239. Georg (Still pending: porting to docutils' latest latex writer.) -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0kpSwACgkQN9GcIYhpnLBCUACfcFWLiaEx9rcQbnUjcUjq9XIp QZYAni3Ndc1K0FcswuDspRsMuaQ7uJX0 =XQ1p -END PGP SIGNATURE- -- 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 output to Github
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.11.2010 21:17, schrieb Michael Jones: Hi, Just a quick heads up, embarrassingly I missed this update back in Dec 2009, but it is presumably the best way of getting your Sphinx stuff on to github-pages without their Jekyll code ignoring the directories starting with an underscore. https://github.com/blog/572-bypassing-jekyll-on-github-pages It is also covered in the pages guide: http://pages.github.com/ This pretty much renders the sphinx-to-github extension useless, but it was nice whilst it lasted! So the Sphinx documentation, which kindly references sphinx-to-github, should probably be updated as well. http://sphinx.pocoo.org/faq.html#using-sphinx-with Done in rev fedbf384e64f. Thanks! Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0kpqEACgkQN9GcIYhpnLB7YwCgpUDcB6aBI9p6rCUpnF8Umm+Z 8scAn0BI8NPU2fGxMnlg88IcJD91RDeC =NXeP -END PGP SIGNATURE- -- 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] Sorted Glossary with german umlauts
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 15.12.2010 10:56, schrieb Jan Ulrich Hasecke: Hi, I have a sorted glossary with: .. glossary:: :sorted: But the german umlauts äöü are not sorted after a, o and u as I would expect it, but after z. Is there a way to configure this? The same issuse arises in the index where words with a leading umlaut are sorted into symbols The glossary and index issues should be fixed for HTML output in Sphinx 1.0.6. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0kqMMACgkQN9GcIYhpnLDVoQCgnhCgHnKcr/bpLlbWoHJlYT/j MaUAoJn0SJv+q7ZBwFHnCwbfAEFyXFVJ =76rD -END PGP SIGNATURE- -- 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] domain supported in literalinclude's pyobject
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.12.2010 20:15, schrieb Jean-Daniel: Hello, I am a big fan of literalinclude and especially its pyobject option [1]. For those not familiar with, this extract an object from a Python source file to display the formatted source code. Before that, I would the option lines and would have to count which lines of the source file to be included. Now that I can write documentation for code on other languages, I want even more: is it possible to extract objects from other languages, say C functions with a syntax similar to : .. literalinclude:: my_source.c :c:object: main Is such a feature supported? It *could* certainly be supported, but someone needs to write the code to do that. For C (and C++) it would probably mean a full parser since C function definitions are not really easily recognizable. Having such a parser would also make the starting of a autodoc for C possible. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0kqSkACgkQN9GcIYhpnLBxPwCbB5chOa5XklasJsgg896Llr2g CQoAoJrMO5lYx27LTeudRqaP82ZTjTFT =QFCW -END PGP SIGNATURE- -- 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: unimpressed with latex output
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 17.12.2010 21:42, schrieb Michael P. Soulier: On 17/12/10 Guenter Milde said: Yes. At least, this limitation should be documented. Ideally the parser should halt before passing it to latex. This should now be handled a little more gracefully in version 1.0.6. Sounds like Sphinx needs to catch up to docutils then. Volunteers welcome. I wish I had the time to fix the world's code. Sadly I find I must typically work on my own. Yeah :| I have limited time as well to work on Sphinx, but this project is definitely worth it, looking at all the great improvements that the docutils writer has known in recent time. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0kqZcACgkQN9GcIYhpnLC1YwCeNvnWR/IklqruOQEj8utynZjv izIAn1RtPOedJdSjQyMcydrzlF6oZ/K1 =sxiP -END PGP SIGNATURE- -- 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] Segmentation fault with import scipy.signal
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 05.01.2011 17:29, schrieb LaurenP: Hi, I'm trying to use Sphinx to automatically generate documentation for a python project. One of the modules requires the scipy.signal package, which I try to import using the following: import scipy.signal as signal. Although the code runs just fine, making html with Sphinx results in a segmentation fault (output below). I can, however, use import scipy as sp, making sure to put scipy directory in my sys.path and the documentation is generated without any problems, but of course, then I won't have the functionality in my code that I need. I made a very simple test case to demonstrate the problem, creating a testclass with a few docstrings. I am inluding it below along with my .rst's. Commenting out the line import scipy.signal as signal, everything works quite well. Thanks for any insights into how to avoid seg faulting while still importing scipy.signal. Lauren Hi Lauren, I've tried to reproduce this with the example you attached, however I don't get a segfault with scipy 0.8.0 -- which version are you using? Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0ldQoACgkQN9GcIYhpnLCEcgCZAfsiphlNeTQu4vP2iF3KOV7A 0J8AoIw6q7A4mMfyT4ng62enWnbkaczZ =/APb -END PGP SIGNATURE- -- 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] Sphinx 1.0.6 released
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.0.6, a bug-fix release in the 1.0 series, fixing a number of bugs and regressions in the 1.0 line of releases. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText source files). Website: http://sphinx.pocoo.org/ What's new in 1.0 (very short version)? === Lots of stuff; most important of all domains support (see blog post at http://pythonic.pocoo.org/2009/9/12/new-in-sphinx-1-0-domains), new HTML themes, new output formats (manpage, epub). The full list is at http://sphinx.pocoo.org/latest/changes.html. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0jpKQACgkQN9GcIYhpnLBx8QCfaDM5BpIVxFM5tnWQCzhx8UiF 1QQAnjXFpCTpIrYE/eAzkGMEZRFL7xyR =0mEb -END PGP SIGNATURE- -- 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] Enumerated Lists not rendered
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 02.01.2011 10:31, schrieb beberlei: Hello everyone, I am running into slight problems with enumerated lists. My rst file is rendered correctly by Github https://github.com/doctrine/orm-documentation/blob/master/en/reference/annotations-reference.rst However that is rendered wrong with Sphinx http://www.doctrine-project.org/docs/orm/2.0/en/reference/annotations-reference.html A colleague suggested me that Docutils needs a space between each list item, however that doesnt solve it. What wonders me is that some lists are rendered correctly in the above example, but only those where there is a ..note:: box nested inside an item. What am I doing wrong? Hi, your pages include a configurationblock.css style file that defines inline- display for ul.simple elements. Docutils uses the simple class too, to denote lists that do not have p around each item content. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0gS+MACgkQN9GcIYhpnLBVrgCeOFZJXuWzNbzWuSwk/LGqrMvw sDwAnj50/l4rsr0ZFHa2BFeEQDUH335V =tL33 -END PGP SIGNATURE- -- 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] Enumerated Lists not rendered
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi, I can only recommend using Firebug or a similar tool for your browser of choice; with this, finding where the styling of an element comes from is a matter of seconds. cheers, Georg Am 02.01.2011 11:44, schrieb Benjamin Eberlei: Woah thanks!! Oversight by myself, thanks for pointing at the obvious i've been missing for hours now :-) On Sun, 02 Jan 2011 10:56:51 +0100 Georg Brandl ge...@python.org wrote: Am 02.01.2011 10:31, schrieb beberlei: Hello everyone, I am running into slight problems with enumerated lists. My rst file is rendered correctly by Github https://github.com/doctrine/orm-documentation/blob/master/en/reference/annotations-reference.rst However that is rendered wrong with Sphinx http://www.doctrine-project.org/docs/orm/2.0/en/reference/annotations-reference.html A colleague suggested me that Docutils needs a space between each list item, however that doesnt solve it. What wonders me is that some lists are rendered correctly in the above example, but only those where there is a ..note:: box nested inside an item. What am I doing wrong? Hi, your pages include a configurationblock.css style file that defines inline- display for ul.simple elements. Docutils uses the simple class too, to denote lists that do not have p around each item content. Georg - -- 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. -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0giI8ACgkQN9GcIYhpnLB5JwCfeMKDmAMwUYZUHm4ck7KIhfB5 NnMAniawaf8SCoMQCHlyvbeRXBgJjOL2 =yQyt -END PGP SIGNATURE- -- 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] Including RST files from arbitrary directories
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 02.01.2011 11:57, schrieb Pavel Solin: Hi, I have Sphinx docs for my project in a directory /home/pavel/repos/hermes/doc/. I tried to move a file /home/pavel/repos/hermes/doc/src/hermes2d/tutorial-1/mesh.rst to another location /home/pavel/repos/hermes/hermes2d/tutorial/01-mesh/doc/ (to be in the directory with the actual tutorial example). However, then the file is not found. Trying to get to it using a relative path such as ../../../hermes2d/tutorial/01-mesh/doc/mesh does not help. Can this be done? Any hints would be appreciated. It can be done, but with a trick: leave a .rst file under /doc and put only .. include:: ../relative/path/to/mesh.rst into it. Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0giNUACgkQN9GcIYhpnLD+RwCfQcS6QzbXiRs4fQUF0Jp8rsO4 ulkAn0ZR6auPgBC5alkq+Ty5hx5j+Wdy =0RET -END PGP SIGNATURE- -- 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: cpp domain: problems handling short type
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Thanks Akira, this is now fixed with rev 6a2b85e5591d.
Georg
Am 28.12.2010 15:44, schrieb Akira Kitada:
Forgot to mention this. short cannot prefix short, so I think
_modifiers['short'] should be fixed, too.
On Tue, Dec 28, 2010 at 11:39 PM, Akira Kitada akit...@gmail.com wrote:
Hello,
It seems Sphinx cpp domain does not understand signed short and
unsigned short.
When Sphinx read code below:
.. cpp:member:: signed short Spam::ham
.. cpp:member:: unsigned short Spam::ham
it generated the following warnings:
WARNING: Invalid definition: expected end of definition, got
u'Spam::ham' [error at 13]
signed short Spam::ham
WARNING: Invalid definition: expected end of definition, got
u'Spam::ham' [error at 14]
The patch below fixes the issue:
--- sphinx/domains/cpp.py.orig 2010-12-28 23:30:12.0 +0900
+++ sphinx/domains/cpp.py 2010-12-28 23:30:38.0 +0900
@@ -444,8 +444,8 @@
'mutable': None,
'const':None,
'typename': None,
-'unsigned': set(('char', 'int', 'long')),
-'signed': set(('char', 'int', 'long')),
+'unsigned': set(('char', 'int', 'short', 'long')),
+'signed': set(('char', 'int', 'short', 'long')),
'short':set(('int', 'short')),
'long': set(('int', 'long', 'double'))
}
Thank you,
Akira
-BEGIN PGP SIGNATURE-
Version: GnuPG v2.0.16 (GNU/Linux)
iEYEARECAAYFAk0a/lUACgkQN9GcIYhpnLDVuwCfdSjlNXUWAFsY4sBE/+xiCV6V
LmkAoJP1Dq6iIEqc2wASKHOLSBvRZU19
=3tqq
-END PGP SIGNATURE-
--
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 crashes python
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 27.12.2010 20:15, schrieb Bill Bedford: Since upgrading to Mac OS X 10.6 I have not been able to run Sphinx. the error is:- york:Mousa admin$ make html sphinx-build -b html -d build/doctrees source build/html Fatal Python error: Interpreter not initialized (version mismatch?) make: *** [html] Abort trap I have reinstall the system, python and Sphinx, and made sure there is only one version of Sphinx on the machine. Hi Bill, I'm not sure what could cause this in Sphinx itself, other than a broken install of Python. If you use autodoc, be aware that it imports modules, so they could be a cause of this crash as well. You could use the new faulthandler module from http://pypi.python.org/pypi/faulthandler to debug this further. cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0a/rgACgkQN9GcIYhpnLAwSgCfYMqCmuC+cTaJ39UHStNIwAP7 cDQAniYQ+8dUIAMjd71i0BqUqvlbFgzg =kEQM -END PGP SIGNATURE- -- 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] Short syntax for a cross-file reference?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 29.12.2010 15:36, schrieb Victor Stinner: Hi, I started with an unique document written in reST format. I used `reference name`_ which was replaced with reference name which is a link to a section with has a different name. After switching to Sphinx, I replaced the references by :ref:`reference name`, but it is replaced by section name (link to the section) instead of reference name. Example: --- 8 -- .. index:: UCS-2, UCS-4, UTF-16, UTF-16-LE, UTF-16-BE, UTF-32, UTF-32- LE, UTF-32-BE .. _UCS-2: .. _UCS-4: .. _UTF-16: .. _UTF-16-LE: .. _UTF-16-BE: .. _UTF-32: .. _UTF-32-LE: .. _UTF-32-BE: UCS-2, UCS-4, UTF-16 and UTF-32 ''' UCS-2 and UCS-4 encodings encode each code point to exactly one word of, ... --- 8 -- (eg. :ref:`UTF-16`) becomes (eg. UCS-2, UCS-4, UTF-16 and UTF-32) I can use (eg. :ref:`UTF-16 UTF-16`), but how can I add a link to the UTF-16 section without repeating the reference name? Easy: don't have different labels anymore, so that it becomes :ref:`UTF-16 utf` and so on. :) Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0bUw4ACgkQN9GcIYhpnLAMLwCeM5muUG4PlMt4+6e/Y0qMlS6u eFwAn15W4WqKae9qAFWPFKzyzhL3lGmR =UXaf -END PGP SIGNATURE- -- 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] Where's the documentation for stuff like :mod:?
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 26.12.2010 15:03, schrieb cool-RR: On Sun, Dec 26, 2010 at 1:43 PM, Ramiro Morales cra...@gmail.com mailto:cra...@gmail.com wrote: On Sun, Dec 26, 2010 at 8:06 AM, cool-RR ram.rac...@gmail.com mailto:ram.rac...@gmail.com wrote: Hi, Is there a concentrated place where I can see all the stuff like :mod: :file: etc.? (How is that called, role?) Go to the Glossary, lookup 'Role' and follow the links from there. -- Ramiro Morales I did follow the links from there, but couldn't find where all the roles are listed. For example. I got here: http://sphinx.pocoo.org/markup/inline.html#inline-markup While it has some roles, it doesn't have all of them. For example, I can't find :mod: there. See http://sphinx.pocoo.org/domains.html#domains (which is also linked at the top of the http://sphinx.pocoo.org/markup/inline.html document). Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0a6HgACgkQN9GcIYhpnLDxUQCaA/9rcY9eC6WVvUUXp+7itaTf odsAnjLai5z9IAc/2rV+5XLDdNnvfBMV =2oBe -END PGP SIGNATURE- -- 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] Use the ifconfig extension and include a section in the code
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.12.2010 02:50, schrieb Stéphane Wirtel: Hi all, .. ifconfig:: technical It's just a test -- docutils.paragraph This section won't be included why ? -- docutils.section === I tried to use the ifconfig extension because I want to split the technical of the functional side in a document for a customer. So, I thought that extension was the right one, but after reading the source code, I noticed that the ifconfig directive is replaced by the children nodes, but in this case, it's a paragraph and a paragraph only contains paragraphs and not an other kind of element (section, list, image, ...) I would like to know if it is possible and how to replace the paragraph of ifconfig by a section, image, list, etc... Do you have some ideas or advices ? Actually your example should work (anything in the body of the ifconfig directive will be included conditionally) -- provided that technical is a config value. Otherwise you should see an error in the output of sphinx-build that technical is not defined. ifconfig is actually more of a demo extension, and for this kind of conditional inclusion, you'd better use the only directive (which is always available, no extension needed). It works similary, see http://sphinx.pocoo.org/markup/misc.html#directive-only cheers, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0DM2EACgkQN9GcIYhpnLCvFgCcCLXdj4p6hILDeP9J2TjTRKpO eUMAnjAPp4ev0Pdpx/Ycnhkrw76OMME/ =gheZ -END PGP SIGNATURE- -- 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.
