-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 03/06/12 22:15, Takayuki Shimizukawa wrote:
`tabularcolumns` only supported by `latex` writer (HTML and other
writer skip tabularcolumns).
I eventually came to the same conclusion. The documentation page doesn't
explicitly make that clear, and
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
I've been trying to use tabularcolumns to get some columns right justified.
.. tabularcolumns:: |l|r|r|
+--+--+---+
|United States |22,358|19%|
+--+--+---+
|Spain |6,975 |5% |
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
I have a bunch of data presented using field lists like this (dummy labels
and data):
:Validity: 37.2
:Duration: 17 of 6
I'd like to provide a way of linking to another ref which has detailed
explanations of what each label means and how it was
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 31/05/12 05:52, ralsina wrote:
There is no such variable in covers. I could add it, but where do I get
the value?
The value is available in the other source rst files I supply to sphinx
and ultimately comes from conf.py. You can see a list of
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
I'm very happy with the pdfs produced by rst2pdf when integrated with
Sphinx. I also have my own cover page template for it. However I can't
work out how to get the version information into the template.
Neither |version| nor ${version} work,
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 28/05/12 07:20, Viktor Haag wrote:
I /believe/ that ifconfig depends on values set in conf.py, and I
haven't met with much success trying to pass configuration values
through from the build process into the running application.
I have no
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 28/05/12 07:51, Viktor Haag wrote:
It's just that maybe that design wasn't communicated effectively when
the features were described to end-users. 'ifconfig' and 'only' don't
exclude/include stuff entirely as one might expect:
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 18/01/12 09:52, Nikolaj wrote:
I would like to have
56 first line of code 57 second line of code
in my documentation.
What is the easiest/best way to do this?
It looks like you can use rst include:: and use the
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 07/01/12 07:54, Neck Acm wrote:
With 116 mb source file, the _build directory is 669 mb after sphinx-
build aborted the build process
If you just want to get something built then I suggest trying using a 64
bit operating system (you are almost
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
On 06/01/12 14:53, Bruce Eckel wrote:
I always have the first line of a code listing example as a comment
that gives the name of the file in the comment, but if you had a tag
that required the file name then you could use that to extract the code
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
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.
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Please change the URL to:
http://apidoc.apsw.googlecode.com/hg/index.html
This is because of a change at Google Code hosting.
Roger
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.10 (GNU/Linux)
Comment: Using GnuPG with Mozilla -
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
My normal html builds go just fine, but the html help build fails like this:
HHC5013: Error: URL reference in the TOC cannot be resolved:
py-modindex-class 'sphinx.domains.python.PythonModuleIndex'.html.
Roger
-BEGIN PGP SIGNATURE-
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
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
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Chris Collins wrote:
Good idea. In case you're not familiar, Java has an automatic
documentation feature called JavaDoc.
I used Java from around its 1.0 days and consequently am very familiar with
Javadoc. It was the first time a mainstream
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Chris Collins wrote:
Yes. Separating the Javadocs from the source code is definitely not the
way I wanted to go.
I generate a whole bunch of my docs by parsing C source files - the docs are
actually about resulting Python visible functions and
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Georg Brandl wrote:
Now in trunk as revision b1b653a6f05d.
I've started converting my doc to use this and it works well. (I did
previously try to write my own role objects based on docutils documentation
and the code that expands :pep:`NN` but gave
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Georg Brandl wrote:
Now in trunk as revision b1b653a6f05d.
It isn't documented so you may want to add that doing a linkcheck does
expand these and verify the links.
Roger
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (GNU/Linux)
Comment:
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Georg Brandl wrote:
Am 19.12.2009 07:57, schrieb Lennart Regebro:
Hi all!
It would be nice to have a ReST/Sphinx filter for aspell. I have no
clue how to make such a thing, and do not exactly feel like learning
it at the moment. :) Maybe
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Jason S wrote:
The table-of-contents pane seems to screw up printing HTML files.
I just tried with FF 3.5 on Linux (Ubuntu 9.10). The table of contents pane
is not printed at all. The main text is however printed correctly across
the full width of
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
dinoboff wrote:
You should look at paver for creative build solution:
http://www.blueskyonmars.com/projects/paver/
I solved it via overriding the sdist from distutils and adding the doc into
the zip file afterwards with the right paths which
Santiago Suarez Ordoñez wrote:
I'm sorry I never got the time to try it myself, but you can test it
using Selenium's doc:
Roberto's problem is that he doesn't have source documents with every
Sphinx/RST feature in them. So each time he uses source from a project,
someone on that project has
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Roberto Alsina wrote:
Remove it from setup.py then, it should work just fine.
I had assumed it was one the dependencies that was insisting on
simplejson, but fortunately it was the top level setup.py so that did
turn out to be easy.
The generated
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Georg Brandl wrote:
The tip is unfortunately broken at the moment;
Sadly it is the only thing I run. Partly old habits and partly because
I can put the checkout somewhere innocuous and not have to worry about
operating system packaging. As a
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
With a just updated hg pull -u, I get the following exception:
Exception occurred:
File /space/sphinx/sphinx/roles.py, line 185, in xfileref_role
if titleistarget:
NameError: global name 'titleistarget' is not defined
Roger
-BEGIN PGP
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Georg Brandl wrote:
since Sphinx is already widely used and in production use
I have been wondering if it would be easier (and shorter) to list the
projects that *do not* use Sphinx :-)
Roger
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Timmie wrote:
I would like to give feedback for the development but also be able to
build my docs sucessully.
I've only been using the development version and very rarely has there
been an issue, usually mentioned here and fixed before I even
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Roman wrote:
I am just starting with Sphinx and I cant understand how I should
integrate regular documentation with the one, extracted from the
source code?
In your conf.py, have this:
extensions = ['sphinx.ext.autodoc']
To document a module,
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Baby Coder wrote:
Got it:
exclude_trees = ['gdp\xsr', 'gdp\sid', 'gdp\xam']
(This is Windows.)
That gives an error with Python (invalid \x escape). It would work if
each string was raw (prefixed with r) or the backslashes were doubled
up.
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Georg Brandl wrote:
I'm glad about every comment and criticism.
One thing to consider is that some us are unable to create themed
content due to not being artistic enough. Generally I would like to
point to an existing theme designed by someone
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Jorge Vargas wrote:
anyone has done something like this?
It sounds like you want a wiki that uses rst syntax with some sort of
hook so you can Sphinx over all the files. Trac can have the documents
in rst format and has a hooking mechanism,
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
sandro dentella wrote:
I read many posts on serach but still cannot figure out which is the
search algorithm.
The search is done by the browser (client side). When your
documentation is built, sphinx generates an index mapping search terms
to
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Happy Birthday :-) Hopefully you aren't spending any of it reading this.
Georg Brandl wrote:
The margins and code size can of course be customized using different
preamble settings.
Care to update the documentation with examples? I have no clue
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Mark Eichin wrote:
On Fri, Nov 14, 2008 at 2:17 PM, Glenn Hutchings [EMAIL PROTECTED] wrote:
Cheers for a great tool that actually makes programmers *want* to
write documentation!
Yeah - I've noticed the effect, but don't understand it :-)
A
Georg Brandl wrote:
It finds one occurrence per file, and already finds one for comments in
the primer file.
Ah, so it is showing the first match per file.
This is of course not the optimum. I should add some way to find text in
headings first.
Ideally the results should be in a quality
In my generated doc, I detect the class:: and insert a new section that
does show up, but I'd really like the members listed as well (in this
case one, two, three).
Somebody would have to write an extension for that. :)
Before each method I can put in a section (ie underline with method
Go to http://sphinx.pocoo.org/contents.html and enter comments in the
search box. It seems to find every usage of comments except the most
useful - the comments section of the rst primer!
It would also be nice if that section had an example.
Roger
Janet Swisher wrote:
Does Trac have an extension for producing a PDF? I haven't heard of
one.
There are several. This is is one example:
http://trac-hacks.org/wiki/CombineWikiPlugin
But for a small user base
like a lab, such a person needs to be explicitly designated.
I would argue
Those are reasonable choices, but not everybody will want them.
However, if there were class attributes on the levels in the TOC
(e.g., toc-tree-l1, toc-tree-l2, etc.), then it would be easier
than it is currently to create specific styles for them. So I would
modify your request in that
If I search for a partial string then it is found. For example
searching for modul will find module etc. I have a page with some
constants that looks like this:
:const:`SQLITE_STATUS_ONE`, :const:`SQLITE_STATUS_TWO`,
:const:`SQLITE_STATUS_THREE`
If I do a search for SQLITE_STATUS then
Max Battcher wrote:
(in my eyes) but the people that prefer single file apparently like
grep-ability.
The raw rst files satisfy that requirement :-)
I personally don't really understand the request/need here, but I'm trying my
best to facilitate the conversation.
Tricky situation.
I have a class with several members and each one has lots of
documentation. That makes the page rather long and you have to scroll a
lot to find anything. How can I get the class members to be listed in
the sidebar.
For example using this page I don't get anything in the sidebar:
= 8
I'm trying to do markup that shows output interspersed with source.
Unfortunately I can't find anything that will work. You can see what
I did with HTML in http://apsw.googlecode.com/files/apsw-3.6.3-r1.html
in the example section.
As an example this is the best I have managed to get so far:
This shows the int portion in the output:
.. method:: length(x) - int
This doesn't:
.. method:: length() - int
ie the output bit is only shown if there are more than zero parameters
listed.
Roger
--~--~-~--~~~---~--~~
You received this message because you are
I'm in the process of shifting to sphinx from plain html doc and
particularly liked that I could get PDF out of this. (Note that I
couldn't care less about latex. The conversion could happen via magic
pixie dust for all I care :) )
Exception occurred:
File
On Oct 21, 9:36 pm, Roger Binns [EMAIL PROTECTED] wrote:
FWIW you also can't do **|version|** or even **foo |version| bar**
It turns out you can't use |version| in most places. I also wanted to
do this:
`pkg-|version|.zip http://example.com/dl/pkg-|version|.zip`_
Roger
46 matches
Mail list logo
