[sphinx-users] Sphinx generated pdf documents

['Jan Pleskac' via sphinx-users]

Hi, 

for our project in chip design industry we would like to have sphinx based 
documentation and do docs as code. Sphinx and extensions ecosystem looks as 
a good candidate and other projects in our domain use sphinx, but not 
exactly how we need/want. Not aware of ready made solution. 

The idea is simple - separate content and structure. 
We need design specification document, verification plan, datasheet and 
similar type of doc traditionally required in chip design space.
  
Would you recommend rst2pdf or rather develop pure LaTeX templates a use in 
sphinx?
 
Both HTML and PDFs make sense for us so it is why I'd like to do .rst / 
sphinx as input, no starting with docs at latex level which might be seen 
as an alternative.

BTW, looking for help with overall doc system setup. 

Best regards,
Jan 

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/982993ee-2271-4325-9d60-39a2f6c8e349n%40googlegroups.com.

[sphinx-users] Integrate documentation into a website with includes

[Jan Ulrich Hasecke]

Hi all,

what would you do if you want to integrate a sphinx documentation into a
website family that uses apache includes to have a common navigation header?

We have several sites using different software. All sites share a common
navigation header and footer with apache includes. Our overall CSS is
derived from bootstrap.

Do you know of a good starting point to incorporate a sphinx website in
such a setup?

TIA
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/4fc0b0ed-c319-ab5a-ff25-cc1afec38075%40mailbox.org.

Re: [sphinx-users] relative link from sphinx doc to GitHub repo

[Jan Valošek]

I am sorry for unclear question.

For example; https://github.com/my_repo/docs/documentation.rst is, after 
build and deploy, visible at e.g mywebsite.com/support/documentation.html 
<http://www.google.com/url?q=http%3A%2F%2Fmywebsite.com%2Fsupport%2Fdocumentation.html&sa=D&sntz=1&usg=AFQjCNFcF56Co1AVj4JimW1GI2c5bmv6zQ>.
 
But https://github.com/my_repo/some_file.txt is not after deploy visible at 
mywebsite.com/... URL . This file is still only at GitHub (
https://github.com/my_repo/some_file.txt). How can I include this file to 
deployed public URL? (I know I could put this file physically into 
/https://github.com/my_repo/docs/_static folder, deploy public URL and then 
create relative link, but I do not want to move some_file.txt into _static 
folder, I would like to let this file in 
https://github.com/my_repo/some_file.txt).

Jan


Dne úterý 7. července 2020 12:47:09 UTC+2 Matt from Documatt napsal(a):
>
> I don't understand the last question. But to tell it in other words:  
> Referred URL must be relative to docs public URL. Sphinx reference `text 
> `_ will just become text. Sphinx use URL as is - 
> it doesn't check if it points to an existing file, is relative, copies 
> because it's referenced, or whatever. 
>
> For example, if https://github.com/my_repo/docs/documentation.rst 
> <https://www.google.com/url?q=https%3A%2F%2Fgithub.com%2Fmy_repo%2Fdocs%2Fdocumentation.rst&sa=D&sntz=1&usg=AFQjCNGlG6xQyVZjmcd3PFuUdRglTx_7xw>
>  will 
> be, after build and deploy, visible at e.g.  
> mywebsite.com/support/documentation.html 
> <http://www.google.com/url?q=http%3A%2F%2Fmywebsite.com%2Fsupport%2Fdocumentation.html&sa=D&sntz=1&usg=AFQjCNFcF56Co1AVj4JimW1GI2c5bmv6zQ>,
>  
> and https://github.com/my_repo/some_file.txt will be deployed at 
> mywebsite.com/static/some_file.txt, a relative URL in reference inside 
> documentation.rst will be `Some file <../static/some_file.txt>`_.
>
> Matt
> https://blog.documatt.com
>
> On Tue, Jul 7, 2020 at 10:57 AM Jan Valošek  > wrote:
>
>> Hello Matt,
>> thanks for quick response!
>>
>> Does it mean that the file I want to create reference has to be located 
>> at public URL where RST source file will be published? However I have this 
>> file located only at GitHub.
>>
>> Jan
>>
>> Dne úterý 7. července 2020 9:32:55 UTC+2 Matt from Documatt napsal(a):
>>>
>>> Hello Jan,
>>> you can use relative URI reference like `Some_file <../some_file.txt>`_. 
>>> Important is only to keep in mind that it is not relative to the RST source 
>>> file (docs/documentation.rst), but to the public URL where RST source 
>>> will be published.
>>>
>>> For example, if docs/tutorial.rst ends up as 
>>> mysite.com/docs/tutorial.html, a  reference `Some_file 
>>> <../some_file.txt>`_ will point to mysite.com/some_file.txt.
>>>
>>> Matt
>>> https://blog.documatt.com
>>>
>>>
>>> On Tue, Jul 7, 2020 at 9:15 AM Jan Valošek  wrote:
>>>
>>>> I would like to create symbolic link inside sphinx doc (inside 
>>>> https://github.com/my_repo/docs/documentation.rst file) pointing to 
>>>> file in same GitHub repo (e.g. https://github.com/my_repo/some_file.txt). 
>>>> Something like this:
>>>>
>>>> `Some_file <https://github.com/my_repo/some_file.txt>`_
>>>>
>>>> However, example above is absolute link. I would like to create 
>>>> relative link; something like this:
>>>>
>>>> `Some_file <../some_file.txt>`_
>>>>
>>>> Is it possible?
>>>>
>>>> Thank you,
>>>> JV
>>>>
>>>> -- 
>>>> You received this message because you are subscribed to the Google 
>>>> Groups "sphinx-users" group.
>>>> To unsubscribe from this group and stop receiving emails from it, send 
>>>> an email to sphinx...@googlegroups.com.
>>>> To view this discussion on the web visit 
>>>> https://groups.google.com/d/msgid/sphinx-users/51373cde-a797-4595-9436-6260e0c25d78o%40googlegroups.com
>>>>  
>>>> <https://groups.google.com/d/msgid/sphinx-users/51373cde-a797-4595-9436-6260e0c25d78o%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>> .
>>>>
>>> -- 
>> You received this message because you are subscribed to the Google Groups 
>> "sphinx-users" group.
>> To unsubscribe from this group and stop receiving emails from it, send an 
>> email to sphinx...@googlegroups.com .
>> To view this discussion on the web visit 
>> https://groups.google.com/d/msgid/sphinx-users/58ac6dd5-ac81-4448-ac20-c83d19ec2073o%40googlegroups.com
>>  
>> <https://groups.google.com/d/msgid/sphinx-users/58ac6dd5-ac81-4448-ac20-c83d19ec2073o%40googlegroups.com?utm_medium=email&utm_source=footer>
>> .
>>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/a3f1060d-97b9-4402-9507-9eccffaeebaco%40googlegroups.com.

Re: [sphinx-users] relative link from sphinx doc to GitHub repo

[Jan Valošek]

Hello Matt,
thanks for quick response!

Does it mean that the file I want to create reference has to be located at 
public URL where RST source file will be published? However I have this 
file located only at GitHub.

Jan

Dne úterý 7. července 2020 9:32:55 UTC+2 Matt from Documatt napsal(a):
>
> Hello Jan,
> you can use relative URI reference like `Some_file <../some_file.txt>`_. 
> Important is only to keep in mind that it is not relative to the RST source 
> file (docs/documentation.rst), but to the public URL where RST source 
> will be published.
>
> For example, if docs/tutorial.rst ends up as mysite.com/docs/tutorial.html, 
> a  reference `Some_file <../some_file.txt>`_ will point to 
> mysite.com/some_file.txt.
>
> Matt
> https://blog.documatt.com
>
>
> On Tue, Jul 7, 2020 at 9:15 AM Jan Valošek  > wrote:
>
>> I would like to create symbolic link inside sphinx doc (inside 
>> https://github.com/my_repo/docs/documentation.rst file) pointing to file 
>> in same GitHub repo (e.g. https://github.com/my_repo/some_file.txt). 
>> Something like this:
>>
>> `Some_file <https://github.com/my_repo/some_file.txt>`_
>>
>> However, example above is absolute link. I would like to create relative 
>> link; something like this:
>>
>> `Some_file <../some_file.txt>`_
>>
>> Is it possible?
>>
>> Thank you,
>> JV
>>
>> -- 
>> You received this message because you are subscribed to the Google Groups 
>> "sphinx-users" group.
>> To unsubscribe from this group and stop receiving emails from it, send an 
>> email to sphinx...@googlegroups.com .
>> To view this discussion on the web visit 
>> https://groups.google.com/d/msgid/sphinx-users/51373cde-a797-4595-9436-6260e0c25d78o%40googlegroups.com
>>  
>> <https://groups.google.com/d/msgid/sphinx-users/51373cde-a797-4595-9436-6260e0c25d78o%40googlegroups.com?utm_medium=email&utm_source=footer>
>> .
>>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/58ac6dd5-ac81-4448-ac20-c83d19ec2073o%40googlegroups.com.

[sphinx-users] relative link from sphinx doc to GitHub repo

[Jan Valošek]

I would like to create symbolic link inside sphinx doc 
(inside https://github.com/my_repo/docs/documentation.rst file) pointing to 
file in same GitHub repo (e.g. https://github.com/my_repo/some_file.txt). 
Something like this:

`Some_file `_

However, example above is absolute link. I would like to create relative 
link; something like this:

`Some_file <../some_file.txt>`_

Is it possible?

Thank you,
JV

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/51373cde-a797-4595-9436-6260e0c25d78o%40googlegroups.com.

[sphinx-users] Second edition of my Sphinx book

[Jan Ulrich Hasecke]

Dear all,

I am happy to announce the second edition of my Sphinx book
"Software-Dokumentation mit Sphinx" covering version 2.0. It is written
in German. Prefaces by Georg Brandl and Eric Holscher.

https://www.amazon.com/dp/1793008779

The second edition gained nearly 60 pages compared to the first edition.

I would be more than happy if you would feature the book on the homepage
under the headline "Examples"

https://www.sphinx-doc.org/en/master/

Thanks a lot for all the help I've got on this list.

Have a nice Worker's Day!

Jan Ulrich Hasecke

-- 
Software-Dokumentation mit Sphinx
https://www.amazon.de/dp/1793008779
Paperback: 282 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] What are the changes that affects users in 2.0

[Jan Ulrich Hasecke]

Hi all,

I am currently finishing my second edition of my Sphinx book. While
editing the book I followed the changes in Sphinx 1.8.

Looking at
http://www.sphinx-doc.org/en/master/changes.html#release-2-0-0-beta1-in-development
I don't see many changes that affects the normal user. Am I correct?

What is the reason for the release change to 2.0 (and not to 1.9)? Is it
mostly because we drop the support for Python 2.7 and 3.4?

Are there any other changes I should cover in a user manual?

Cheers
juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] [how to?] ref to section in file

[Jan]

Hello all,

Is there way to reference to the section in different file without 
duplicating section title in lablel and malforming the url link
consider following files as an example.

Currently what I'm doing is:

file_1.rst

File 1
===


.. _file_1-section-1:

Section 1
-

Section 2
-

More info at `section1`_

.. _section1: #section-1


file_2.rst

File 2
==


Section 1
-

More info at :ref:`file_1-section-1`



This leads into several different URLs


* default url in sidebar built by sphinx *file_1.html#section-1*
* URL from my reference inside file_1.rst which is same as one built by 
sphinx: *file_1.html#section-1*
* URL of the reference from the inside file_2.rst: 
*file_1.html#file_1-section-1*

And this feels really inconsistent and it's a tedious process to duplicate 
section headers every time.

I would rather have an option that build throws warnings or broke if the 
reference is broken.



One of the approaches would be to have power to do something like this:

file_1.rst

File 1
===


Section 1
-

Section 2
-

More info at :ref:`section-1`
or
More info at :ref:`.#section-1`
or even
More info at :ref:`file_1#section-1`


file_2.rst

File 2
==


Section 1
-

More info at :ref:`file_1#section-1`



Is there any way to achieve this?
And if not why is this not a good idea?


Thank you

Jan.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Is it possible to create pdf offline from a site ?

[Jan Ulrich Hasecke]

Am 19.10.18 um 07:16 schrieb Eldad Cohen:
> Is it possible to create offline version such as pdf ?
> 

If you created the project with sphinx-quickstart you can generate a pdf
with "make latexpdf". TeXlive or another TeX Distribution has to be
installed.

Other builders are listed here:
http://www.sphinx-doc.org/en/master/usage/builders/index.html

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Short name for members in documentation

[Jan Ulrich Hasecke]

In a reference you can write:

py:meth:`~tarfile.TarFile.close`

to get "close()" only.

juh



On 05.09.2018 09:35, Rahul Surana wrote:
> Hi,
> 
> Is there an option or config variable that can be set/added to sphinx to
> avoid showing fully qualified name of a member?
> Consider below sample page:
> 
> ---
> */python.sphinx.documentation.example.test.module_members.fully_qualified_name/*
> 
> <<>>
> 
> class
> /python.sphinx.documentation.example.test.module_members.fully_qualified_name.TestClass/():
>     Bases: object
> 
>     <<>
> 
> def
> /python.sphinx.documentation.example.test.module_members.fully_qualified_name.testfunction/(name1=True,
> name2=False, name3=None,..):
>      <<>>
> 
> 
> ---
> 
> Given the user has navigated to "python.sphinx.documentation.example"
> page for documentation, prefixing the modname to member name
> or displaying the fully qualified name looks a bit overkill in certain
> cases.
> 
> Consider the "*testfunction*" function above, on the first look it is
> harder to identify where the arguments for the function start.
> 
> 
> 
> I went through the source code and identified that updating below did
> the trick for me:
> 
>   * For displaying shorter names:
> 
> 
> Change in sphinx.domains.python.PyObject.add_target_and_index:339
> 
> |
> signode['names'].append(fullname)   =>signode['names'].append(name_cls[0])
> 
> signode['ids'].append(fullname)     =>signode['ids'].append(name_cls[0])
> |
> 
> 
>   * For using shorter names in references:
> 
> 
> Change in sphinx.writers.html.HTMLWriter:355
> 
> |
> format =u'%s'
>                                                                    
> =>refname =node['ids'][0]
>                                                                    
> =>refname =refname,rsplit('.',1)[1]if'.'inrefname elserefname
> .body.append(format
> %(node['ids'][0],title,self.permalink_text))=>.body.append(format
> %(node['ids'][0],title,self.permalink_text))
> |
> 
> 
> I could use the below changes in my local installation but i don't want
> to patch sphinx on every release. [Note:
> Since self.env.domaindata['py']['objects'] mapping would use fullname
> for key, multiple members with same name across packages wouldn't mess
> up the doc]
> Instead it would be much appreciated if sphinx supported this change.
> 
> 
> Thanks in advance!
> 
> -- 
> You received this message because you are subscribed to the Google
> Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to sphinx-users+unsubscr...@googlegroups.com
> .
> To post to this group, send email to sphinx-users@googlegroups.com
> .
> Visit this group at https://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] sphinx.ext.imgconverter and SVG images in PDF

[Jan Ulrich Hasecke]

On 25.08.2018 05:21, Komiya Takeshi wrote:
> Hi Jan,
> 
> Why are you disappointed? Does our extension not work well?
> Please let me know in detail.

I tried the extension on a small notebook where it crashes. But on my
desktop it works.

>From the description "As a result, you don’t mind what image format the
builder supports." I guessed that I could use whatever input format I have.

So I tried to use a simple pdf screenshot made on Apple with Paparazzi
which makes real vector pdf screenshots. The result is a PNG file with a
wrong bounding box. I guess that this is an Imagemagick problem maybe
only in combination with this pdf. I didn't test more.

And I still have to test the resolution of the PNG files as they need to
have a good resolution for printing.

I also tried
https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter
The advantage seems to be that it converts SVG to PDF vector files so
that resolution should be no problem.

But as I had problems with Inkscape in the past, when I converted a PDF
to SVG or vice versa manually, I wonder how well these extensions work
in production.

But that said: sphinxcontrib-svg2pdfconverter seems to do the same
conversion as svg.sty does in plain LaTeX so there is no better way.

juh




-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] sphinx.ext.imgconverter and SVG images in PDF

[Jan Ulrich Hasecke]

Hi,

anybody using this extension in production?

I am testing the extension and the results are disappointing.

I found the extension while I was searching for svg support in latex
conversion in this issue: https://github.com/sphinx-doc/sphinx/issues/1907

The issue is closed with reference to sphinx.ext.imgconverter.

The whole topics seems to be quite difficult.

I tried a minimal example here:
https://tex.stackexchange.com/questions/122871/include-svg-images-with-the-svg-package

without success.

So there is a long way to go until we have a good single source
publishing solution with svg images.

Any ideas how to solve this in upcoming versions?

juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Sphinx-1.8.0b1 released.

[Jan Ulrich Hasecke]

Hi all,

while 1.8.0b1 runs some of my projects without problems I cannot build a
pdf because xindy is missing on debian stretch.

Does anyone know how to install xindy on debian stretch?

juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] How to deploy the documentation

[Jan Ulrich Hasecke]

Hi all,

I am updating the Sphinx book I wrote in 2014 and could integrate a new
chapter about deployment. I guess there are several ways to deploy a
Sphinx documentation. Are there any canonical ways I should cover?

If I had to deploy a static website I would do it with git hooks, but
maybe there are better options.

So here is my question. How do you deploy your documentation?

TIA
juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] math_numfig

[Jan Ulrich Hasecke]

Please consider this obsolete. Sorry for the noise.
juh

On 03.08.2018 10:25, Jan Ulrich Hasecke wrote:
> Hi all,
> 
> I tried to set math_numfig to false when numfig is enabled. There is no
> difference in the output. Is math_numfig always true if numfig true?
> 
> http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-math_numfig
> 
> 
> TIA
> juh
> 

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] math_numfig

[Jan Ulrich Hasecke]

Hi all,

I tried to set math_numfig to false when numfig is enabled. There is no
difference in the output. Is math_numfig always true if numfig true?

http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-math_numfig


TIA
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] best way to move files while keep the old path as redirect

[Jan Ulrich Hasecke]

On 31.07.2018 07:14, Tzach Livyatan wrote:
> Thanks
> This solves the internal links issue (in a nice way!) but not links from
> external domains.

Maybe this can help you:

https://tech.signavio.com/2017/managing-sphinx-redirects

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] html_baseurl problems

[Jan Ulrich Hasecke]

Hi all,

after setting html_baseurl like this:

html_baseurl = 'https://www.example.com'

I get no canonical link in my output.

Is there anyything else I have to set or is this a bug?

juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Access rights issue at Mac OS Ver. 10.13.5

[Jan Ulrich Hasecke]

Why don't you install Sphinx in a virtual environment?

$ pyvenv sphinxenv
$ source sphinxenv/bin/activate
$ pip install Sphinx
$ sphinx-quickstart doc
$ cd doc
$ make html

juh

On 30.06.2018 07:58, Christian Bernert wrote:
> The *sphinx-quickstart* on my Mac was without errors.
> 
> christians-air:~ Chris$ sudo port select --set python2 python27
> 
> Selecting 'python36' for 'python2' succeeded. 'python27' is now active.
> 
> christians-air:~ Chris$ sudo port select --set sphinx p27-sphinx
> 
> Selecting 'p36-sphinx' for 'sphinx' succeeded. 'p27-sphinx' is now active.
> 
> christians-air:~ Chris$ which sphinx-quickstart
> 
> /opt/local/bin/sphinx-quickstart
> 
> christians-air:~ Chris$ sphinx-quickstart
> 

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Strange problem with numref

[Jan Ulrich Hasecke]

On 16.06.2018 10:00, Komiya Takeshi wrote:
> Did you check the referenced section is numbered? That is required by
> numref role.
> If not, please add :numbered: option to your toctree directive.

That's it. Shame on me. I knew about this. :-(

I'll make a big attention block in the new revision of my Sphinx book.

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Strange problem with numref

[Jan Ulrich Hasecke]

Hi,

I am using numref in two projects.

In one project I get these error messages:

WARNING: no number is assigned for section:

Cross referencing with ref is no problem. Anchors are ok.

In conf.py:

numfig = True
numfig_secnum_depth = 3

Any hints how to debug this?

juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] coverage

[Jan Ulrich Hasecke]

Hi all,

can someone shed some light on the configuration variables:


coverage_c_path

coverage_c_regexes

coverage_ignore_c_items

The documentation is quite pauciloquent.

http://www.sphinx-doc.org/en/stable/ext/coverage.html

juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Re: Sphinx ignores trailing newline "\n" from tabulate rst output

[Jan]

I never figured out why Sphinx wasn't recognizing the newline characters 
"\n", but I solved my problem by reworking my python output (in my conf.py) 
so that it was a list of lists, and after I use the tabulate function, I 
split the output on "\n" as such: 
headers = ['Column Name', 'Data Type', 'Length', 'Precision', 'Scale', 
'Description']
tabulate_columns = tabulate(this_table_columns, tablefmt='rst', headers = 
headers)
tabulate_split = [x.split(',')for x in tabulate_columns.split('\n')]
table_dict_tabulate["table_columns"] = tabulate_split

Then I read the output in my tables.rst file as such:
{% for item in table_dict_tabulate  %}

**Table Name:** {% filter upper %} **{{ item.table_nam }}** {% endfilter %}
**Description: {{ item.table_comment }}**

{% for table in item.table_columns %}{%  for column in table %}{{ column 
}}{% endfor %}
{% endfor %}
{% endfor %}

And it looked great.



On Tuesday, April 10, 2018 at 10:20:14 PM UTC+12, Jan wrote:
>
> I'm generating some rst tables in python using the python-tabulate module:
>
> headers = ["Column Name", "Data Type", "Length", "Precision", "Scale", 
> "Description"]
> tabulate_col = tabulate(this_table_columns, tablefmt='rst', headers = 
> headers)
>
> The "this_table_columns" variable is a python list containing lists of 
> column data.
> I then add this rst table as an object to an existing python dictionary as 
> the table_columns value, and in python the output (if printed) looks like 
> this:
>
> [
> {'table_nam': 'Table1',
> 'table_comment': 'Table 1 comments.', 
> 'table_columns': u'
> ==  ===    ===  ===  
> ===\n
> Column Name Data TypeLengthPrecisionScale
> Description\n
> ==  ===    ===  ===  
> ===\n
> Column 1integer32   0 \n
> Column 2varchar  40  The stage 
> of a buildings lifecycle.\n
> ==  ===    ===  ===  
> ==='
> }, 
> {'table_nam': 'Table2', etc.
>
>
> As you can see, tabulate puts the whole contents of the rst output as 
> unicode with the "u".
>
> However, when I try and load this data into a sphinx rst template in 
> ReadTheDocs as such:
>
> {% for item in schema_tab  %}
> Table Name: {% filter upper %} {{ item.table_nam }} {% endfilter %}
> Description: {{ item.table_comment }}
>
> {{ item.table_columns }}
> {% endfor %}
>
> Sphinx seems to ignore the trailing newline character "\n" and doesn't 
> format the table correctly:
>
> Table Name: Table1
> Description: Table 1 comments.
>
> Column Name Data Type Length Precision Scale Description 
> == ===  === === 
> === Column 1 integer 32 0 _1 Column 2 
> varchar 40 The stage of a buildings lifecycle. == 
> ===  === === ===
>
> Table Name: Table2
>
> Description: Table 2 comments.
>
> Column Name Data Type Length Precision Scale Description = 
> ===  === === 
> === Column 1 32 0  
> Column 2 varchar 40 The value for column 2. = === 
>  === === 
> ===
> etc.
>
> Why does sphinx ignore the newline character? This seems to prevent me 
> from using the nice tabulate module ability to generate ReST tables easily.
> Any ideas on how to prevent ReadTheDocs/Sphinx from ignoring trailing 
> newlines? I don't see any configuration options in ReadTheDocs settings 
> related to this.
>
>
>
>
>
>
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Sphinx ignores trailing newline "\n" from tabulate rst output

[Jan]

I'm generating some rst tables in python using the python-tabulate module:

headers = ["Column Name", "Data Type", "Length", "Precision", "Scale", 
"Description"]
tabulate_col = tabulate(this_table_columns, tablefmt='rst', headers = 
headers)

The "this_table_columns" variable is a python list containing lists of 
column data.
I then add this rst table as an object to an existing python dictionary as 
the table_columns value, and in python the output (if printed) looks like 
this:

[
{'table_nam': 'Table1',
'table_comment': 'Table 1 comments.', 
'table_columns': u'
==  ===    ===  ===  
===\n
Column Name Data TypeLengthPrecisionScale
Description\n
==  ===    ===  ===  
===\n
Column 1integer32   0 \n
Column 2varchar  40  The stage 
of a buildings lifecycle.\n
==  ===    ===  ===  
==='
}, 
{'table_nam': 'Table2', etc.


As you can see, tabulate puts the whole contents of the rst output as 
unicode with the "u".

However, when I try and load this data into a sphinx rst template in 
ReadTheDocs as such:

{% for item in schema_tab  %}
Table Name: {% filter upper %} {{ item.table_nam }} {% endfilter %}
Description: {{ item.table_comment }}

{{ item.table_columns }}
{% endfor %}

Sphinx seems to ignore the trailing newline character "\n" and doesn't 
format the table correctly:

Table Name: Table1
Description: Table 1 comments.

Column Name Data Type Length Precision Scale Description == 
===  === === 
=== Column 1 integer 32 0 _1 Column 2 
varchar 40 The stage of a buildings lifecycle. == 
===  === === ===

Table Name: Table2

Description: Table 2 comments.

Column Name Data Type Length Precision Scale Description = 
===  === === 
=== Column 1 32 0  
Column 2 varchar 40 The value for column 2. = === 
 === === 
===
etc.

Why does sphinx ignore the newline character? This seems to prevent me from 
using the nice tabulate module ability to generate ReST tables easily.
Any ideas on how to prevent ReadTheDocs/Sphinx from ignoring trailing 
newlines? I don't see any configuration options in ReadTheDocs settings 
related to this.







-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Re: Newbie: can I combine dynamic data to one page?

[Jan]

I've figure out that if I add:
html_additional_pages = {
'schema1': 'schema1.html' }
to my conf.py, I can get my schema1.html file located in my _templates 
folder to appear and work correctly with the dynamic content.

However, I don't seem to be able to link to it from my toctree in my 
index.rst file.

Is it possible to link to an html file in "_templates" folder from an item 
in my toctree?




On Friday, April 6, 2018 at 6:46:23 PM UTC+12, Jan wrote:
>
> I ended up trying something which gets me part of what I'm looking for, 
> but still leaves me without the structure I'm looking for.
>
> To get a nice looking html table which I could control formatting with a 
> custom CSS, I placed a "custom.css" file in a "_static" folder. I also 
> placed a "page.html" file in a "_templates" folder. That page html file 
> looks like this:
> {% extends "!page.html" %}
> {{ super() }}
> {% block body %}
> {% filter upper %}
> Schema: {{ schema_gen["name"] }} 
> {% endfilter %}
> Description: {{ schema_gen["comment"] }} 
> 
>
> 
> {% for item in outputschema  %}
> Table Name: {% filter upper %} {{ item["table_nam"] }} {% endfilter 
> %}
> Description: {{ item["table_comment"] }}
> {% if item["table_columns"] %}
> 
> 
> 
> 
> Column Name
> Data Type
> Length
> Precision
> Scale
> Description
> 
> 
> {% for columns in item["table_columns"] %}
> 
> {% for column in columns %}
> {{ column }}
>  
> {% endfor %}
> 
> {% endfor%}
> 
> 
> {% endif %}
> 
> {% endfor %}
> 
>
>
> {% endblock %}
>
> After uploading to my repo, Sphinx automatically generated my ReadTheDocs 
> docs and created a very nice looking index.html page with my tables 
> formatted correctly, and using the css I needed. 
>
> I'm still confused because this created my tables in my INDEX page. How do 
> I leave my index page intact (containing other ReStructureText content) 
> without my inherited "page.html" content, but have a sub-page listed in my 
> index page toctree with this new html content (ie schema1) ?
>
> My index.rst:
>
> .. toctree::
>
>schema1
>schema2
>
> I want my schema1.html file to contain my tables as I've dynamically 
> generated them in the code block above.
> I'm quite confused about how I can potentially use the inheritance 
> templating to work in a single subpage only, rather than in my index page.
>
> I tried putting a file named schema1.html in my "_templates" folder, but 
> that didn't do anything.
>
> I must be missing something quite fundamental to inheritance in Sphinx.
> What am I not understanding?
>
>
>
> On Thursday, March 29, 2018 at 2:50:00 PM UTC+13, Peter Burdine wrote:
>>
>> A few things:
>> 1) You may want to consider another jinja extension to sphinx: 
>> https://pypi.python.org/pypi/sphinx-jinja.  We use YAML as the 
>> datasource, though it could be anything maps to Python lists/dicts (json, 
>> xml, etc).  You can then either reference the a file with the jinja 
>> template, or you can embed the jinja code in your .rst files.  We have 
>> found it is easiest to make list tables for this.  You can use 
>> {% if loop.first %}
>> to setup your table headers.
>>
>>
>> 2) The builder controls the output formatting not the reST input (unless 
>> you use tablularcolumns for LaTeX, but that is another story).  Have you 
>> tried: 
>> https://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file-to-sphinx
>>
>>
>> On Wednesday, March 28, 2018 at 12:45:44 AM UTC-7, Jan wrote:
>>>
>>> I'm trying to understand sphinx, and I'm thoroughly not understanding 
>>> how to implement even some basic concepts. I've created a sphinx project 
>>> linked to my readthedocs account. Everything works to generate my basic 
>>> index.rst file in read the docs. I'm trying to follow the ideas of adding 
>>> dynamic input to a specific page within my project, as mentioned here: 
>>> http://ericholscher.com/blog/2016/jul/25/integrating-jinja-rst-sphinx/
>>>
>>> My objective is to setup my sphinx project so that whenever a specific 
>>> text file changes in my /docs folder, it updates my ReadTheDocs content 
>>> dynamically/automatically.
>>>
>>> My /docs folder has these key elements:
>>>
>>> parsethisfile.txt
>>> conf.py
>>> index.rst
>>> Database.rst
>>> ...
>>>
>

[sphinx-users] Re: Newbie: can I combine dynamic data to one page?

[Jan]

I ended up trying something which gets me part of what I'm looking for, but 
still leaves me without the structure I'm looking for.

To get a nice looking html table which I could control formatting with a 
custom CSS, I placed a "custom.css" file in a "_static" folder. I also 
placed a "page.html" file in a "_templates" folder. That page html file 
looks like this:
{% extends "!page.html" %}
{{ super() }}
{% block body %}
{% filter upper %}
Schema: {{ schema_gen["name"] }} 
{% endfilter %}
Description: {{ schema_gen["comment"] }} 


{% for item in outputschema  %}
Table Name: {% filter upper %} {{ item["table_nam"] }} {% endfilter 
%}
Description: {{ item["table_comment"] }}
{% if item["table_columns"] %}




Column Name
Data Type
Length
Precision
Scale
Description


{% for columns in item["table_columns"] %}

{% for column in columns %}
{{ column }}
 
{% endfor %}

{% endfor%}


{% endif %}

{% endfor %}



{% endblock %}

After uploading to my repo, Sphinx automatically generated my ReadTheDocs 
docs and created a very nice looking index.html page with my tables 
formatted correctly, and using the css I needed. 

I'm still confused because this created my tables in my INDEX page. How do 
I leave my index page intact (containing other ReStructureText content) 
without my inherited "page.html" content, but have a sub-page listed in my 
index page toctree with this new html content (ie schema1) ?

My index.rst:

.. toctree::

   schema1
   schema2

I want my schema1.html file to contain my tables as I've dynamically 
generated them in the code block above.
I'm quite confused about how I can potentially use the inheritance 
templating to work in a single subpage only, rather than in my index page.

I tried putting a file named schema1.html in my "_templates" folder, but 
that didn't do anything.

I must be missing something quite fundamental to inheritance in Sphinx.
What am I not understanding?



On Thursday, March 29, 2018 at 2:50:00 PM UTC+13, Peter Burdine wrote:
>
> A few things:
> 1) You may want to consider another jinja extension to sphinx: 
> https://pypi.python.org/pypi/sphinx-jinja.  We use YAML as the 
> datasource, though it could be anything maps to Python lists/dicts (json, 
> xml, etc).  You can then either reference the a file with the jinja 
> template, or you can embed the jinja code in your .rst files.  We have 
> found it is easiest to make list tables for this.  You can use 
> {% if loop.first %}
> to setup your table headers.
>
>
> 2) The builder controls the output formatting not the reST input (unless 
> you use tablularcolumns for LaTeX, but that is another story).  Have you 
> tried: 
> https://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file-to-sphinx
>
>
> On Wednesday, March 28, 2018 at 12:45:44 AM UTC-7, Jan wrote:
>>
>> I'm trying to understand sphinx, and I'm thoroughly not understanding how 
>> to implement even some basic concepts. I've created a sphinx project linked 
>> to my readthedocs account. Everything works to generate my basic index.rst 
>> file in read the docs. I'm trying to follow the ideas of adding dynamic 
>> input to a specific page within my project, as mentioned here: 
>> http://ericholscher.com/blog/2016/jul/25/integrating-jinja-rst-sphinx/
>>
>> My objective is to setup my sphinx project so that whenever a specific 
>> text file changes in my /docs folder, it updates my ReadTheDocs content 
>> dynamically/automatically.
>>
>> My /docs folder has these key elements:
>>
>> parsethisfile.txt
>> conf.py
>> index.rst
>> Database.rst
>> ...
>>
>> In my conf.py I've added some python which parses a txt file, and then 
>> creates references to the object:
>>
>> def rstjinja(app, docname, source):
>> """
>> Render our pages as a jinja template for fancy templating goodness.
>> """
>> # Make sure we're outputting HTML
>> if app.builder.format != 'html':
>> return
>> src = source[0]
>> rendered = app.builder.templates.render_string(
>> src, app.config.html_context
>> )
>> source[0] = rendered
>>
>> def setup(app):
>> app.connect("source-read", rstjinja)
>>
>> html_context = {
>> #'outputschema': schema_list_out
>> }
>>
>> The "schema_list_out" is a list (or I could make a dictionary) which 
>> contains elements for a database schema, such as table names, comments, 
>> column names and column parameters.
&

[sphinx-users] Newbie: can I combine dynamic data to one page?

[Jan]

I'm trying to understand sphinx, and I'm thoroughly not understanding how 
to implement even some basic concepts. I've created a sphinx project linked 
to my readthedocs account. Everything works to generate my basic index.rst 
file in read the docs. I'm trying to follow the ideas of adding dynamic 
input to a specific page within my project, as mentioned 
here: http://ericholscher.com/blog/2016/jul/25/integrating-jinja-rst-sphinx/

My objective is to setup my sphinx project so that whenever a specific text 
file changes in my /docs folder, it updates my ReadTheDocs content 
dynamically/automatically.

My /docs folder has these key elements:

parsethisfile.txt
conf.py
index.rst
Database.rst
...

In my conf.py I've added some python which parses a txt file, and then 
creates references to the object:

def rstjinja(app, docname, source):
"""
Render our pages as a jinja template for fancy templating goodness.
"""
# Make sure we're outputting HTML
if app.builder.format != 'html':
return
src = source[0]
rendered = app.builder.templates.render_string(
src, app.config.html_context
)
source[0] = rendered

def setup(app):
app.connect("source-read", rstjinja)

html_context = {
#'outputschema': schema_list_out
}

The "schema_list_out" is a list (or I could make a dictionary) which 
contains elements for a database schema, such as table names, comments, 
column names and column parameters.

If I wanted to generate dynamic ReadTheDocs pages, I've successfully been 
able to add some variables to my Database.rst file like this:
{% for schema_item in outputschema %}
**Schema Name: {{ schema_item["name"] }}**
{% endfor %}
and sphinx correctly creates a Database.html file that shows this:

Schema Name: buildings

More importantly, I'm trying to create nice looking tables for the items in 
my "schema_list_out" list. The only way I've been able to do that is using 
the python tabulate module (in my conf.py), where I generate the table 
within python, output as rst, and save it as a list element object within 
my "schema_list_out". If I use the right control structure in my rst, I 
generate a nice looking table in rst format that looks correct in my sphinx 
generated output:


But the problem here is I have no way of controlling how this looks inside 
the rst file because it's RST, and I can't add HTML, css or anything else 
to control how the table looks (like table width, color etc). reST markup 
doesn't seem to offer enough control over a table.
How do I create dynamically created tables which can be formatted nicely, 
in RST? If I could create the tables easily in my Database.html, I'd do 
that, but it's not a template, it's generated by sphinx from my 
Database.rst. I can't figure out how to create my Database.html myself, 
with the jinja control structures inside of it. How do do that?




-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] SOLVED: WARNING: no number is assigned for section:

[Jan Ulrich Hasecke]

On 28.02.2018 08:54, Jan Ulrich Hasecke wrote:
> Hi all,
> 
> I have problems with numref references to sections in one of my projects.
> 
> In conf.py:
> 
> numfig = True
> 
> numfig_secnum_depth = 3
> 
> 
> While the cross reference with :ref: works :numref: gives me the error:
> 
> WARNING: no number is assigned for section: kap-aufbau
> 
> Testing the configuration in a test project shows the expected result.
> 
> Any hints?


Never ever forget the option :numbered: in toctree if you want to use
numref in html.

:-)
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] German Output With lualatex

[Jan Ulrich Hasecke]

Hi all,

I don't get german chapternames etc. when I compile my project.

The problem seems to be that lualatex does not know the language ngerman.

I edited the tex-file until I get the desired output.

Here is the diff.

10c10
< \documentclass[letterpaper,10pt,ngerman]{sphinxmanual}
---
> \documentclass[letterpaper,10pt,german]{sphinxmanual}
21c21
< \setmainlanguage{ngerman}
---
> \setmainlanguage{german}
55,57c55,57
< \addto\captionsngerman{\renewcommand{\figurename}{Abb.}}
< \addto\captionsngerman{\renewcommand{\tablename}{Tab.}}
< \addto\captionsngerman{\renewcommand{\literalblockname}{Quellcode}}
---
> \addto\captionsgerman{\renewcommand{\figurename}{Abb.}}
> \addto\captionsgerman{\renewcommand{\tablename}{Tab.}}
> \addto\captionsgerman{\renewcommand{\literalblockname}{Quellcode}}
59,60c59,60
<
\addto\captionsngerman{\renewcommand{\literalblockcontinuedname}{Fortsetzung
der vorherigen Seite}}
<
\addto\captionsngerman{\renewcommand{\literalblockcontinuesname}{continues
on next page}}
---
>
\addto\captionsgerman{\renewcommand{\literalblockcontinuedname}{Fortsetzung
der vorherigen Seite}}
>
\addto\captionsgerman{\renewcommand{\literalblockcontinuesname}{Fortsetzung
auf der nächsten Seite}}
183c183

As you can see I switched from "ngerman" to "german".

And \literalblockcontinuesname is not set to a german string at all.

I think at least the latter issue is a bug.

Is there something special I have to set in conf.py to get the right output?


juh


-- 
Das ZEN von Pandoc
Bücher und E-Books einfach und professionell produzieren
http://www.amazon.de/Das-ZEN-von-Pandoc-professionell/dp/1505218799/
Paperback (232 Seiten) und E-Book

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] WARNING: no number is assigned for section:

[Jan Ulrich Hasecke]

Hi all,

I have problems with numref references to sections in one of my projects.

In conf.py:

numfig = True

numfig_secnum_depth = 3


While the cross reference with :ref: works :numref: gives me the error:

WARNING: no number is assigned for section: kap-aufbau

Testing the configuration in a test project shows the expected result.

Any hints?

TIA
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] coverage config values

[Jan Ulrich Hasecke]

Hi all,

can someone give me an example of how to set these config variables?


coverage_c_path

coverage_c_regexes

coverage_ignore_c_items


The first expects a list the others a dict.


TIA
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] linkcode_resolve problem

[Jan Ulrich Hasecke]

Hi all,

I have this in conf.py:

def linkcode_resolve(domain, info):
if domain != 'py':
return None
if not info['module']:
return None
filename = info['module'].replace('.', '/')
return "https://github.com/sphinx-doc/sphinx/blob/master/%s.py"; %
filename

While this works:

.. module:: sphinx.environment.collectors.asset

.. class:: ImageCollector


This does not link to the right file, nameley the __init__.py

.. module:: sphinx.environment

.. class:: BuildEnvironment


What do I miss?

I am working with the current Sphinx version.

TIA
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] role any behaviour

[Jan Ulrich Hasecke]

On 28.01.2018 16:54, Komiya Takeshi wrote:
> Hi,
> 
> In my local, following example works fine.
> 
> ```
> references using any role: :any:`Builder`
> 
> .. py:class:: sphinx.builders.Builder
> ```
> 
> Could you share any example?

Referencing to objects documented in the project itself works, I am
trying to setup an intersphinx reference

Maybe my setup is not correct:

conf.py:

intersphinx_mapping = {
'sphinx': ('http://sphinx-doc.org', None)
}

test.rst
:any:`Builder`


> Thanks,
> Takeshi KOMIYA
> 
> 2018-01-25 23:13 GMT+09:00 Jan Ulrich Hasecke :
>> Hi all!
>>
>> I tried to reproduce the behaviour of the docs.
>> http://www.sphinx-doc.org/en/stable/markup/inline.html?highlight=referenc#role-any
>>
>> """
>> For example, in the Python domain a reference of :any:`Builder` would
>> match the sphinx.builders.Builder class.
>> """
>>
>> This does not work in my project. I have to use
>> :class:`sphinx.builders.Builder` to get the right link.
>>
>> Message of sphinx-build is:
>>
>> WARNING: 'any' reference target not found: Builder
>>
>>
>> Any hints?
>> juh
>>
>> --
>> You received this message because you are subscribed to the Google Groups 
>> "sphinx-users" group.
>> To unsubscribe from this group and stop receiving emails from it, send an 
>> email to sphinx-users+unsubscr...@googlegroups.com.
>> To post to this group, send email to sphinx-users@googlegroups.com.
>> Visit this group at https://groups.google.com/group/sphinx-users.
>> For more options, visit https://groups.google.com/d/optout.
> 

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] role any behaviour

[Jan Ulrich Hasecke]

Hi all!

I tried to reproduce the behaviour of the docs.
http://www.sphinx-doc.org/en/stable/markup/inline.html?highlight=referenc#role-any

"""
For example, in the Python domain a reference of :any:`Builder` would
match the sphinx.builders.Builder class.
"""

This does not work in my project. I have to use
:class:`sphinx.builders.Builder` to get the right link.

Message of sphinx-build is:

WARNING: 'any' reference target not found: Builder


Any hints?
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] numfig_format and translations

[Jan Ulrich Hasecke]

Hi all,

when I set numfig_format like this:

numfig_format = {
   'figure': 'Figure %s',
   'table': 'Table %s',
   'code-block': 'Listing %s',
   'section': 'Section %s'
 }


I can not translate the strings, because the strings are no part of the
generated po-files.

But the default strings like 'Fig %s' are stored in sphinx.po located in
site-packages/sphinx/locale/xx/LC_MESSAGES

The only way to change the strings including English is to put a
customized sphinx.po in the locale_dirs of the project and build the
English version wird "-D language=en".

Is that correct?

juh

-- 
Soziale Plastik. Die Kunst der Allmende
Essay zum 30. Todestag von Joseph Beuys
http://www.amazon.de/dp/1523458763/
Taschenbuch, 130 Seiten, EUR 9,90

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] set toctree contents as sibling instead of child of heading

[Jan Ulrich Hasecke]

On 27.11.2017 19:21, ryanwist wrote:
> Given this:
> 
>    Main
>    
> 
>    Subhead1
>    
>    
>    .. toctree::
>    
>       Subhead2
>       Subhead3
>       
>    Subhead4
>    
> 
> 
> I'd like to get this:
> 
>    Main
>      - Subhead1
>      - Subhead2
>      - Subhead3
>      - Subhead4
>   
> but, understandably, I get this:
> 
>    Main
>      - Subhead1
>        - Subhead2
>        - Subhead3
>      - Subhead4
>   
> Is there a way to break the context of "Subhead2" in the rst such that
> the toctree contents are identified as siblings of "Subhead1" rather
> than as children?

I am not aware of such a possibility.

If you include a file with toctree the headlines of the included file
are always one level lower.

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] sphinx_rtd_theme and topic directive

[Jan Ulrich Hasecke]

Am 26.06.2017 um 13:24 schrieb Joanna:
> I use sphinx_rtd_theme. 
> 
> I try to use topic directive. 
> 
> .. topic:: This is topic
> 
> Subsequent indented lines comprise
> the body of the topic, and are
> interpreted as body elements.

AFAIR topic in most themes has no frame as it is used as a simple
headline eg. to be set in front of your footnotes.

juh


-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Sphinx-1.6.2 has been released

[Jan Ulrich Hasecke]

Am 30.05.2017 um 17:35 schrieb Komiya Takeshi:
> Hi,
> 
> Sorry, I can't read German. But I guess it says the value of
> `` is invalid.
> It seems you are not specifying `epub_identifier`. The content.opf
> says it is "unknown" (the default value of epub_identifier).
> Usually ISBN or URLs are used to the value.
> 
> Please check it.


After contemplating over
http://www.idpf.org/epub/30/spec/epub30-publications.html#sec-opf-dcidentifier
I finally found a solution that validates with epubcheck

The value of epub_identifier did not cause the errors but the value of
epub_id.

epub_id is the internal reference for the dc:identifier metadata.

The example on the idpf site shows it:



http://purl.org/dc/elements/1.1/";>

urn:uuid:A1B0D67E-2E81-4DF5-9E67-A64CBE366809

…





So here the string "pub-id" is the unique-identifier of the metadata
that gives the identifier "urn:uuid..."


I used "pub-id" and "website" as unique-identifier, both were validated.

I did not find a list of good XML names for unique-identifier. For now
I'll stick to pub-id.

The default of Sphinx is an empty string which does not validate.

Maybe we should consider to default to pub-id?

Ciao!
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Sphinx-1.6.2 has been released

[Jan Ulrich Hasecke]

Hi all,

great! Thank you very much for your efforts.

I tried epubcheck on an older project and got two errors.

Verwendung der EPUB 3.0.1 Prüfungen
ERROR(RSC-005):
_build/epub/Das-ZEN-von-Pandoc-1bfda21.epub/content.opf(4,92):
Validierungsfehler: Der Wert des Attributs "unique-identifier" ist
ungültig; es muss ein XML-Name ohne Doppelpunkt sein
ERROR(RSC-005):
_build/epub/Das-ZEN-von-Pandoc-1bfda21.epub/content.opf(14,33):
Validierungsfehler: Der Wert des Attributs "id" ist ungültig; es muss
ein XML-Name ohne Doppelpunkt sein

EpubCheck mit Fehlern abgeschlossen.

Here are the first 22 lines in content.opf. I am confused as the line
numbers don't match the error lines.

The unique-identifier is a git commit number. I don't know why it causes
errors.


http://www.idpf.org/2007/opf"; version="3.0" xml:lang="de"
 unique-identifier="1bfda21"
 prefix="ibooks:
http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0/";>
  http://www.idpf.org/2007/opf";
xmlns:dc="http://purl.org/dc/elements/1.1/";>
de
Das ZEN von Pandoc
unknown
Jan Ulrich Hasecke
unknown
Jan Ulrich Hasecke
2014, Jan Ulrich Hasecke
unknown
2017-05-30T05:50:18Z
2017-05-30T05:50:18Z
1
true
true
vertical

  

-- 
Autoren-Homepage: . http://literatur.hasecke.com
Satiren & Essays: . http://www.sudelbuch.de
Privater Blog:  http://www.hasecke.eu
Netzliteratur-Projekt:  http://www.generationenprojekt.de


-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Sphinx-1.6 final has been released

[Jan Ulrich Hasecke]

Cool. Is this the version with the new epub builder?

I still get a lot of errors with epubcheck.

juh

Am 16.05.2017 um 17:56 schrieb Komiya Takeshi:
> Hi all,
> 
> I'm delighted to announce the release of Sphinx 1.6 final, now available on
> the Python package index at .
> 
> It includes about 33 new features, 29 bug fixes and 23 incompatible
> changes for the 1.5.6 release.
> 
> For the full changelog, go to
> .
> Thanks to all collaborators and contributers!
> 
> 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-doc.org/
> IRC: #sphinx-doc on irc.freenode.net
> 
> Enjoy!
> 

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Metadata on inner front page

[Jan Ulrich Hasecke]

Am 29.12.2016 um 14:09 schrieb Antonis Christofides:
> Hello,
> 
> I've written a book with sphinx. Is it possible to write stuff on the inner
> front page of the PDF produced with "make latexpdf"? Metadata that is, such as
> copyright and edition information.
> 
> In addition, how can I have unnumbered chapters, such as Foreword and 
> Appendix?
> 

This is possible if you use the KOMA-Script document class scrbook and
adjust your config.

https://www.ctan.org/pkg/koma-script

\uppertitleback{Something you want to say on top of the title back}

\lowertitleback{Something you want to say on the bottom of the title back}

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Sphinx 1.5 released

[Jan Ulrich Hasecke]

Hi all,

wonderful, great improvements.

But the epubs still don't validate against epubcheck.

juh

Am 10.12.2016 um 06:23 schrieb Takayuki Shimizukawa:
> Hi all,
> 
> I'm very happy to announce the release of Sphinx 1.5-final available on
> the Python package index at .
> 
> Sphinx-1.5 includes many updates from 1.4.9 version:
> 
> * 67 features
> * 38 incompatible changes
> * 3 deprecations
> * 52 fixes of bugs/buglets
> 
> For the full changelog, go to
> .
> Thanks to all collaborators and contributers!
> I especially appreciate tk0miya who made a great contribution over the
> past year.
> 
> 
> 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-doc.org/
> IRC: #sphinx-doc on irc.freenode.net 
> 
> Enjoy!
> --
> Takayuki SHIMIZUKAWA
> http://about.me/shimizukawa
> 
> -- 
> You received this message because you are subscribed to the Google
> Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to sphinx-users+unsubscr...@googlegroups.com
> .
> To post to this group, send email to sphinx-users@googlegroups.com
> .
> Visit this group at https://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Re: sphinx pdf style

[Jan Ulrich Hasecke]

If you are able to handle xml files you can build a path from sphinx to
ConTeXt to produce very customized pdf files, which is a pain with the
LaTeX-implementation of Sphinx.

ConTeXt is a LaTeX alternative based on LuaTeX. You can customize your
layout with ConTeXt to a great extent.

http://wiki.contextgarden.net/Main_Page

The main advantage:
ConTeXt is able to read xml files, so you could create a singlehtml
output with Sphinx (which is afaik xml compliant) and feed it into ConTeXt.

In this repository you can see how this works generally and how to map
xml to ConTeXt commands.

https://github.com/ousia/from-pandoc-to-context

Of course, the solution does not work out of the box because the Sphinx
output differs to the Pandoc output. But it should be possible.

juh


-- 
Das ZEN von Pandoc
Bücher und E-Books einfach und professionell produzieren
http://www.amazon.de/Das-ZEN-von-Pandoc-professionell/dp/1505218799/
Paperback (232 Seiten) und E-Book

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] epub validation (was: Sphinx 1.3.6 released)

[Jan Ulrich Hasecke]

Hi all,

Am 29.02.2016 um 15:49 schrieb Takayuki Shimizukawa:
> Hi all,
> 
> I'm delighted to announce the release of Sphinx 1.3.6, now available on
> the Python package index at .
> 
> It includes about 10 bug fixes for the 1.3 release series, among them a
> regression in 1.3.5. 
> 
> For the full changelog, go to
> .
> Thanks to all coraborators and contributers!

the pace of improvement is stunning.

One remark though concerning the epub compatibility.

You opened this issue one year ago:
https://github.com/sphinx-doc/sphinx/issues/1376

In the comments you announce improvements of the epub builder if the new
docutils xhtml writer is available.

You removed the improvement from the 1.2.x milestone. Is it still on the
1.3.x milestones and is there a time line when it will be ready.

This improvement would be beneficial to me. If you create ebooks with
Sphinx all EPUB distributors reject your file as it does not validate
with epubcheck. For the moment I have to fix epubs by hand.

juh

-- 
Soziale Plastik. Die Kunst der Allmende
Essay zum 30. Todestag von Joseph Beuys
http://www.amazon.de/dp/1523458763/
Taschenbuch, 130 Seiten, EUR 9,90

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] change page nchange page number between index and normal pagesumber between index and normal pages

[Jan Ulrich Hasecke]

Am 22.01.2016 um 14:48 schrieb Matteo Ghetta:
> 
> If you know how to achieve this in latex (eg. by \frontmatter,
> \mainmatter, \backmatter) you can simple put these commands into your
> source like this:
> 
> 
> .. raw:: latex
> 
>\frontmatter
> 
> 
> actually I'm pretty new to latex.. :)
> I tried your solution adding a .. raw:: latex \frontmatter to one of my
> rst files (I have 9 of them, so 9 chapters).
> In the final pdf generated, **all** the different chapters are
> recognized as \frontmatter, so the whole pdf has no *real* chapters..
> 
> Am I missing something?
>

\frontmatter marks foreword, tableofcontents etc.

Before you start with your first chapter insert:

.. raw:: latex

   \mainmatter

This will start the normal part of your document.

If you want to separate appendices, eg. index, insert this:

.. raw:: latex

   \backmatter

If you want to customize the latex output of Sphinx, have a look at the
available LaTeX documentation.

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] change page nchange page number between index and normal pagesumber between index and normal pages

[Jan Ulrich Hasecke]

Am 22.01.2016 um 12:13 schrieb Matteo Ghetta:
> Hi all,
> I'm struggling with an apparently simple issue.
> 
> What I would like to achieve is to have roman number for the index pages
> and arabic number for the rest of the document. (sphinx -> latexpdf)
> 
> I looked for a solution but I did not find anything.
> 
> Am I missing something?

If you know how to achieve this in latex (eg. by \frontmatter,
\mainmatter, \backmatter) you can simple put these commands into your
source like this:


.. raw:: latex

   \frontmatter


juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Defining new directives and roles

[Jan Ulrich Hasecke]

Hi all,

I want to document ConTeXt commands.

I set up a new directive and role with:


def setup(app):
app.add_object_type('contextcommand', 'contextcommand',
objname='ConTeXt command',
indextemplate='pair: %s; ConTeXt command')

But I have some issues.

A typical ConTeXt command is:

\setupbackgrounds[foo][bar][baz=4]

or

\at{foo}{bar}{baz}

The things in brackets are the options and configurations of the command.

I have to escape the backslash. This is annoying but no big issue.

But I want that only the core command appears in the index not all the
options.

But

.. contextcommand:: \at {foo} {bar} {baz}

makes an entry with the whole line: \at {foo} {bar} {baz}

And I need the full line to reference the command. But I would like to
reference it with the core command name only, like this:

The command :contextcommand:`\\at` does foo bar...

Any hints?

Has anybody yet documented LaTeX or ConTeXt code with Sphinx?

Ciao!
juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] build two levels of documentation from one rst source tree

[Jan Ulrich Hasecke]

Am 03.06.2015 um 17:49 schrieb Kevin Clarke:
> We would like to produce two sets of html documentation. 
>   - description-docs  which provide high level of information from the
> rest source files   ( think
> description of the software functions and what it does)
>   - detailed-docs which contains all contents of description-docs but
> provides extra more detailed information( above + the actual command
> / GUI action to achieve the function of the software and examples of its
> results)
> 
> Is it possible to set up sphinx so that it can generate both outputs
> from the .rst file.  

You can use the ifconfig extension of Sphinx and setup a configuration
variable in conf.py. Eg.

def setup(app):
app.add_config_value('html_set', '', True)

Then you can tag your text like this.

.. ifconfig:: 'detailed' in html_set

   This is the extra detailed information.

To compile the normal version you set html_set to "normal" in conf.py:

html_set = "normal"

If you want to compile the detailed version you set it to "detailed":

html_set = "detailed"


You can use two different conf.py and call sphinx-build with the option -c.


HTH
juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Next/Previous Links broken if index.rst was changed

[Jan Ulrich Hasecke]

Am 05.05.15 um 11:06 schrieb Thomas Güttler:
> If I change the toc order in index.rst file, the rebuild does not
> create new html files
Only changed files are rebuilt.

make clean
make html

should rebuild the whole project.

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Custom theme problems in Sphinx 1.3.1?

[Jan Ulrich Hasecke]

Hi Jack,

I am not an expert with theming Sphinx, but your theme might inherit
from default theme, which now is named classic.

Look into your theme.conf file.

[theme]
inherit = base theme
stylesheet = main CSS name
pygments_style = stylename

set base theme to classic and try again.

http://sphinx-doc.org/theming.html#creating-themes

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Re: [sphinx-dev] documentation coverage

[Jan Ulrich Hasecke]

This is the usual way to use coverage.

1. include sphinx.ext.coverage in extensions in conf.py
2. adjust your path in conf.py so that your module is in the system
path. If your documentation lives in yourmodule/doc try this:

sys.path.insert(0, os.path.abspath('..'))

3. in your rst-file start the documentation of a module with the module
directive.

.. module:: mymodule

4. Call sphinx-build:

$ sphinx-build -b coverage sourcedir builddir

sourcedir is the root dir of your documentation. So if you call
sphinx-build from your root directory you can call it like this:

$ sphinx-build -b coverage . _build/coverage

HTH
juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Better EPUB support in upcoming versions of Sphinx

[Jan Ulrich Hasecke]

Dear developers,

after the release of Sphinx 1.3 I want to ask whether you plan to
improve the support of EPUB in upcoming versions.

If you want to use Sphinx as a multichannel publishing tool to make
books and ebooks support for EPUB3 is crucial.

I just compiled one of my projects with Sphinx 1.3 and got even more
errors with the validator epubcheck than before. In most cases it is not
possible to submit a non-validated epub to publishers like Amazon,
Google or Apple.

Are there any plans?

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] generating documentation from both reST and non-reST?

[Jan Ulrich Hasecke]

Hi Matthew,

Am 27.02.2015 um 20:37 schrieb Matthew Woehlke:
> Now I have a problem. One chunk of the documentation has been written in
> reST. Another (very large) chunk cannot feasibly be written in reST, but
> is written in a project-specific format. I can generate the
> documentation from the reST files just fine, but I am stuck trying to
> figure out how to also process the non-reST files.

You can try to convert the files with Pandoc to ReST. Pandoc is a
versatile document converter, perhaps you can use it with your
"project-specific format."

juh


-- 
Das ZEN von Pandoc
Bücher und E-Books einfach und professionell produzieren
http://www.amazon.de/Das-ZEN-von-Pandoc-professionell/dp/1505218799/
Paperback (232 Seiten) und E-Book

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Re: security relevant bug in epub creation

[Jan Ulrich Hasecke]

Am 27.02.2015 um 20:45 schrieb Matthew Woehlke:
> On 2015-02-16 10:28, Jan Ulrich Hasecke wrote:
>> I just reported this issue.
>> https://github.com/sphinx-doc/sphinx/issues/1730
>>
>> If you have RST-files in your project that are not included by a toctree
>> directive they are nevertheless included into the epub archive.
> 
> (As shimizukawa noted, it's not just ePUB, but all generators.)
> 
> I'm not sure this is a bug... if you want some files to be excluded, why
> are you not listing them thusly in your conf.py?

I think it's not a good idea to automatically include files which are
not explicitly included. During the process of writing you often create
some files which won't be included in the final document. Today Sphinx
leaks information to readers which never was intended to be public.

At least we need a clear warning that not included files are included
during processing. IMHO it would be better, if nothing gets included at
all if not explicitly included.

juh

-- 
Das ZEN von Pandoc
Bücher und E-Books einfach und professionell produzieren
http://www.amazon.de/Das-ZEN-von-Pandoc-professionell/dp/1505218799/
Paperback (232 Seiten) und E-Book

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] security relevant bug in epub creation

[Jan Ulrich Hasecke]

Hi,

I just reported this issue.
https://github.com/sphinx-doc/sphinx/issues/1730

If you have RST-files in your project that are not included by a toctree
directive they are nevertheless included into the epub archive.

This could be a security issue if you provide secret information in the
file.

You should rename not included files so that sphinx does not recognize
them as source files or delete them at all.

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] search CLI tool missing in sphinx

[Jan Ulrich Hasecke]

Hi,

wrong mailinglist. This is the mailinglist for the documentation tool
Sphinx. http://sphinx-doc.org/

juh

Am 18.11.2014 um 15:22 schrieb waseem:
> I am trying to install Sphinx search, I have installed the sphinx in the
> following steps
> 
> downloaded the sphinx from sphinxsearch.com/downloads and extract the
> tar.gz file.
> 
> |  tar -xzvf sphinx-2.2.6-release.tar.gz
>   cd sphinx-2.2.6-release
> ./configure --prefix=/usr/local/sphinx
>  make
>  make install (from the root)
> |
> 
> when I check the /usr/local/sphinx/bin didn't find *search CLI tool*.
> can anyone let me know what I am missing while installing Sphinx Search?
> Thanks in advance!
> 
> -- 
> You received this message because you are subscribed to the Google
> Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to sphinx-users+unsubscr...@googlegroups.com
> .
> To post to this group, send email to sphinx-users@googlegroups.com
> .
> Visit this group at http://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] `genindex` empty problem

[Jan Ulrich Hasecke]

Are there any index directives in your text or directives that
automatically create index entries?

Try to put this in your text somewhere:

.. index:: Foo

Then the term "Foo" is put into the index after running sphinx.

If you document a function like this, Sphinx will automatically create
an index entry.

.. function:: foo

   Blablabla


HTH
juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Simple example for longtable?

[Jan Ulrich Hasecke]

Hi Stefan,

Am 01.10.2014 um 18:45 schrieb stefan.k...@gmail.com:
> Hello everyone,
> 
> can anybody give me a simple example for a longtable in sphinx? I have
> searched for quite a while for this but could not find a simple example
> for that. The release notes of sphinx 0.62 say "Tables now can have a
> “longtable” class, in order to get correctly broken into pages in LaTeX
> output." but I do not have the faintest idea how my tables can have a
> class of a certain type.

Sphinx creates longtables by default. So just create a table in your
source and Sphinx will make it a longtable in LaTeX.

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] i18n: convert .pot back to .rst

[Jan Ulrich Hasecke]

Am 29.07.2014 um 21:31 schrieb anatoly techtonik:
> Hi,
> 
> At PyMove3D we used translation service to convert from German to English.
> Now we want to use English as default. Is there any way to get .rst
> files from
> this translation?


The rst-files should be there as source files in _build/html/_sources,
after you build the english translation.

Just rename them from *.txt to *.rst.

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] literalinclude and long lines

[Jan Ulrich Hasecke]

Hi,

I include a file with literalinclude. Some lines of the file are too
long to be displayed inside the text margins. I cannot alter the file
and I want to preserve line counting because I refer to line numbers in
my explanations.

Can I somehow wrap long lines in literal includes automatically?

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Searching in 600+ files

[Jan Ulrich Hasecke]

Am 13.06.2014 12:30, schrieb Luc Saffre:
> On 12/06/14 21:50, Jan Ulrich Hasecke wrote:
>> Has anyone used Sphinx with more than 600 files?
> 
> It seems that my biggest Sphinx site has about 1300 files:
> 
>   http://lino-framework.org
> 
> Is there an easy way to count the pages in a tree? Here is how I did it:
> 
>   $ find docs -name '*.rst' | wc -l
>   1967
> 
> (And then I subtract about 600 from that number because I have an
> `exclude_patterns`)
> 
> And I cannot complain that the quick search function on that site is slow.

Yeah, no problems to search your site. I'll have to look closer at my
configuration.

juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Searching in 600+ files

[Jan Ulrich Hasecke]

Hi,

I have a project with 600+ html files. The built-in search of Sphinx
cannot handle these amount of files in a reasonable time.

I never had a project with such an amount of files, so I don't know
whether 600+ files are way too much for Sphinx to handle or whether
there is a glitch in my configuration.

Has anyone used Sphinx with more than 600 files?

Is there anything I can do?

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] I want to take away "Release" when i generate pdf

[Jan Ulrich Hasecke]

Hi Almudena,

Am 05.06.2014 13:56, schrieb Almudena Soblechero Garcia:
> Well, here i am one more time :(
> 
> 
> I have other problem, when i generate the pdf, in the first page put me
> "Release", and i don want that here
> 
> Somebody knows how i can solve that???
> 

Just put an empty string into conf.py:

# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''


juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Re: page with "contents:" after the TOC?

[Jan Ulrich Hasecke]

Hi!

Am 04.06.2014 03:02, schrieb Mark Elston:

> But I still get the phantom page after the TOC with the string
> "contents:"
> 
> Does anyone know how to remove that?

Just a shot in the dark, but did you try to use another documentclass?

Maybe this is hardcoded in the class Sphinx uses. You can also try to
avoid fncychap at all.

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[sphinx-users] Documenting LaTeX stuff

[Jan Ulrich Hasecke]

Hi,

is there an extension to document LaTeX macro packages, document classes
etc.?

juh

-- 
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Re: [sphinx-users] Inconsistencies between HTML and LaTeX/PDF

[Jan Ulrich Hasecke]

Only a guess. You can use the caption-package and use \caption* instead of
\caption. I am not sure if it work, but you might be able to redefine
\caption to be \caption* in the preamble. Use the configuration variable
latex_elements with the option preamble for this.


2014-02-24 19:44 GMT+01:00 Peter Eastman :

> Hi Sam,
>
> Thanks for the advice!
>
>
> it's even possible to modify how Sphinx generates your content into LaTeX
>
>
> What's the mechanism for doing that?  It sounds ideal for solving my
> problems.  For example, I've looked for instructions on how to prevent
> LaTeX from numbering the figures, and they all say, "It's easy.  Don't wrap
> your caption in a \caption command, and it won't be numbered."  Which is
> fine if you're writing the LaTeX by hand, but how can I prevent Sphinx from
> including the \caption?
>
> Perhaps I should ask a related question.  In general, are inconsistencies
> between HTML and PDF considered to be bugs?  Is it the goal of the project
> to make all output formats as consistent as possible?  They obviously won't
> be identical: HTML and PDF are different formats with different needs.  But
> that doesn't apply to things like numbering the figure captions and putting
> a title above the bibliography.  There's no reason those can't behave
> identically in all formats, and it would make people's lives easier if they
> did.
>
> Peter
>
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-users+unsubscr...@googlegroups.com.
> To post to this group, send email to sphinx-users@googlegroups.com.
> Visit this group at http://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/groups/opt_out.
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [sphinx-users] trouble with the RAW directive

[Jan Ulrich Hasecke]

Better use the directives include or literalinclude.

.. literalinclude:: ../gits/vcloud-management-tools/lib/application.rb
   :language: ruby


2014-02-24 11:27 GMT+01:00 Azul Inho :

>
> Hey,
>
> I'm pretty new to rstext/sphinx, I am having some trouble getting content
> from an external non-rst text file into a .rst document.
>
> this is the contents of the my .rst file:
>
> "
> The code executed by this job is listed below:
>
> .. raw:: text
>:file: ../gits/vcloud-management-tools/lib/application.rb
> "
>
> sphinx-build doesn't give me any errors, but when no content is generated
> from that 'raw' directive.
> Any clue where I am getting this wrong?
>
> -azul
>
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-users+unsubscr...@googlegroups.com.
> To post to this group, send email to sphinx-users@googlegroups.com.
> Visit this group at http://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/groups/opt_out.
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [sphinx-users] Extension Conflicts?

[Jan Ulrich Hasecke]

For the vertical alignment you can use:
http://sphinx-doc.org/ext/math.html#confval-pngmath_use_preview

I am a bit confused about rst2pdf.pdfbuilder AND latexpdf because I think
rst2pdf.pdfbuilder is an alternative to the LaTeX-Builder.

Anyway, you could use two different conf.py (called html.py and epub.py).
In html.py you use mathjax, in epub.py pngmath. Then you call Sphinx via

sphinxbuild -b html -c html.py sourcedir builddir

or

sphinxbuild -b epub -c epub.py sourcedir builddir


2014-02-22 19:02 GMT+01:00 Eric D :

> I am just trying out Sphinx for the first time (1.1.3 on Ubuntu 13.10) and
> am somewhat frustrated by what appear to be conflicts between certain
> extensions.
>
> When I use 'sphinx.ext.pngmath' to render mathematics, it works for both
> html and epub build targets, but the vertical alignment is painful.
>
> When I use 'sphinx.ext.mathjax' the math renders beautifully in html, but
> not at all in epub.
>
> When I use try to build a pdf version by adding 'rst2pdf.pdfbuilder' to my
> extensions list, and the latexpdf build target, it works great but I can no
> longer build html or epub versions with rendered mathematics.
>
> To sum up, having rst2pdf.pdfbuilder in my extensions list prevents any
> math rendering in html or epub. I suppose the pngmath vs. mathjax question
> isn't a conflict, per se, but I wish I could have *both* extensions and
> have it use the pngmath for epub and mathjax for html.
>
> Is there a way to set up the conf.py so I use only certain extensions with
> each build target? That is, if I am building epub, I only want
> sphinx.ext.pngmath, if html then sphinx.ext.mathjax, and if pdf then
> rst2pdf.pdfbuilder. I can't seem to have all three present at the same time.
>
> Or am I missing some Big Picture concept?
>
> -Eric
>
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-users+unsubscr...@googlegroups.com.
> To post to this group, send email to sphinx-users@googlegroups.com.
> Visit this group at http://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/groups/opt_out.
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] Changing \begin{figure}[htbp]

[Jan Ulrich Hasecke]

Is it possible to change the positioning parameters of LaTeX's figure
directive?

When I insert a figure sphinx creates htbp by default.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] pngmath_use_preview has no effect

[Jan Ulrich Hasecke]

Hi,

I set pngmath_use_preview to True in conf.py but cannot see any difference.

In fact something like this: :math:`a^2 + b^2 = c^2` is not displayed with
the correct baseline in html.

I've installed preview-latex-style on Ubuntu as described here:
http://sphinx-doc.org/latest/ext/math.html#confval-pngmath_use_preview

Any hints?
juh

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [sphinx-users] Re: How to get an imprint on the titleback right before the tableofcontents in latex

[Jan Ulrich Hasecke]

Thanks a lot, I was concerned to hear such an answer. ;-)


2013/11/14 Alex Reinhart 

> I needed to do this for a project I'm working on. I copied
> sphinxmanual.cls (which is placed in the _build/latex/ directory when you
> build a LaTeX file) and placed it in the root of my project as
> "sphinxbook.cls", and told conf.py to copy that in and use "book" as the
> documentclass.
>
> The cls file redefines \maketitle with the Sphinx title page, so I edited
> that, added a \clearpage at the end, and then added my copyright
> information on the new page. You can use \vfill on top to push it to the
> bottom of the page.
>
>
> On Wednesday, November 13, 2013 4:41:08 AM UTC-5, juhasecke wrote:
>>
>> I want to insert imprint information on the page right after the
>> titlepage and before the tableofcontents in my latex output.
>>
>> Any ideas how I can achieve that?
>>
>> In a normal latex project I would solve this with koma-scripts book class
>> and \lowertitleback{foobar}.
>>
>> juh
>>
>>  --
> You received this message because you are subscribed to the Google Groups
> "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to sphinx-users+unsubscr...@googlegroups.com.
> To post to this group, send email to sphinx-users@googlegroups.com.
> Visit this group at http://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/groups/opt_out.
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] Managing big projects

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Hi,

how do you manage big projects with emacs and/or vim. Which plugins,
modes and tricks do you use to handle big Sphinx projects?

How do you outline a project in Sphinx?

How do you tag files with custom tags?

How do you reorder chapters and sections?

juh

- -- 
Plone 4 http://www.hasecke.com/plone-benutzerhandbuch/4.2/
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlG/eGsACgkQPUzUEFbILMTZQACfTncd8cLGAKlNBmUqoPOABIcq
J44An0ZXKych1br7ICIugdqDKDhl98CD
=ZIGb
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] geany plugin ?

[Jan Ulrich Hasecke]

Hi,

the rst support for the editor geany seems to be quite poor. Is there a
plugin for Sphinx?

juh

-- 
Demeter and the Commons of Being
http://www.amazon.com/dp/B00BGPS26W
Speculative essay against loss of ancestry and the arrogation of property

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] Problem with footnotes right after a colon

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Hi,

while this works:

blablabla.«[#]_

this does not:

blablabla.[#]_


Why?

juh
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlFe5r4ACgkQPUzUEFbILMR85gCeNeOQPaVUwHtqepGJ0XVO0C3Q
OEcAoLT/J3+eJebq+cjsmf7Jiicrj0Uv
=mk2q
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] Get rid of "Release foo bar"

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Hi,

as I am writing a book, not the documentation of a program I want to
get rid of the Subtitle "Release..." altogether.

How can I do this?

juh

- -- 
Demeter and the Commons of Being
http://www.amazon.com/dp/B00BGPS26W
Speculative essay against loss of ancestry and the arrogation of property
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlFdoRMACgkQPUzUEFbILMQQxACgpXdDGWa+B4IqYxXcfQ5ccEZ8
b/AAn3s9Gjb0t8pEReVpB1uiIQI1sMAw
=gGcG
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] Rotating a table

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Hi,

how would you rotate a table in the latex output of Sphinx?

I have a large and long table which needs to be printed in a 90° angle
on multiple pages.

juh

- -- 
Demeter and the Commons of Being
http://www.amazon.com/dp/B00BGPS26W
Speculative essay against loss of ancestry and the arrogation of property
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlFdfmwACgkQPUzUEFbILMSLSQCfQlBhkUZkNiCQj64PEvOpFTIy
U7EAn0Y0v6xyipFL8/myiMXPgWP57LuS
=lQw1
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [sphinx-users] Re: [sphinx-dev] Sphinx 1.2 beta 1 released

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 02.04.13 23:27, schrieb rolmei:
> Hi Georg, there is an open pull request for the epub builder that I
> would like to include in the current release. Is there still time
> to include it? How should I proceed? Update the request and merge
> it myself?

Yes, please merge the epub builder into 1.2

I use it, and it works really fine.

juh

- -- 
Demeter and the Commons of Being
http://www.amazon.com/dp/B00BGPS26W
Speculative essay against loss of ancestry and the arrogation of property
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlFb2/IACgkQPUzUEFbILMSygQCfQFR+VbYCBkWZbeTHDhULz3dd
z4wAoLQM1VnZVr/spP8GlBw4wGlQ1dJk
=snBL
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [sphinx-users] Setting the documentclass for the LaTeX writer

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 06.03.13 16:50, schrieb Uwe Ziegenhagen:
> How can I set the used documentclass in the LaTeX module? The
> manual (http://sphinx-doc.org/config.html#latex-options) says I
> should not override 'docclass' but gives no hint to do it the right
> way.

For example in conf.py:

latex_elements = {
'pointsize':'10pt',
'docclass':'scrbook'
}

This will result in something like this in the .tex-file:

\def\sphinxdocclass{scrbook}
\documentclass[a4paper,10pt,ngerman]{sphinxmanual}


juh

- -- 
Demeter and the Commons of Being
http://www.amazon.com/dp/B00BGPS26W
Speculative essay against loss of ancestry and the arrogation of property
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlE9ynoACgkQPUzUEFbILMQy6ACfUJ8whJBGdRdqc479HjkkoG+I
l0YAnj3NmEssUQ+uXW+SUzW+qaoaA200
=zhTI
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [sphinx-users] Re: Not a4 and not letter

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 04.03.13 10:03, schrieb Guenter Milde:
> Normally, code in the latex preamble will just overwrite the effect
> of "letterpaper" or "a4paper". Are there still side effects in the
> DVI, PDF, or Postscript document?

Ok.

Wie kriege ich denn so was hin?

\def\sphinxdocclass{scrbook}
\documentclass[a4paper,DIV=classic,headings=small]{sphinxmanual}

Konkret, wie kriege ich die Optionen "DIV=classic" und
"headings=small" in das LaTeX-Dokument?

juh

-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlE4a1UACgkQPUzUEFbILMQl3ACfVRnLGyhRpAnvdvFzIyrDaLSb
mQsAni5qAgjPnqVk6MKr+yMt7hfyZczM
=Ll5A
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

Re: [sphinx-users] Not a4 and not letter

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 03.03.13 23:47, schrieb gilberto dos santos alves:
> here you find what you need:
> 
> url1:: http://www.andy-roberts.net/writing/latex url2::
> https://wiki.archlinux.org/index.php/TeX_Live_FAQ

No that won't solve my problem.

> But always letterpaper is inserted in the documentclass line: 
> \documentclass[letterpaper,10pt,ngerman]{sphinxmanual}

Sphinx always insert "paper" into the option field of documentclass. I
think this makes things inflexible. If I could leave this blank, it
would help already.

juh



-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlE0UuAACgkQPUzUEFbILMTwsQCgst7CUmEy7ydcjdtTMz97cr6x
/b4An3f/bMv6kSP65TamnVsGNJ3UMUqO
=WIl4
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] Not a4 and not letter

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

How can I set another papersize than a4 or letter in the latex options?

I want to have this in my Tex-file:

\setlength{\paperwidth}{139.7mm}
\setlength{\paperheight}{215.9mm}
\setlength{\pdfpagewidth}{\paperwidth}
\setlength{\pdfpageheight}{\paperheight}

I can do this with

latex_preamble = '''
\setlength{\paperwidth}{139.7mm}
\setlength{\paperheight}{215.9mm}
\setlength{\pdfpagewidth}{\paperwidth}
\setlength{\pdfpageheight}{\paperheight}
'''

latex_elements = {
'pointsize':'10pt',
'docclass':'scrbook'
}

But always letterpaper is inserted in the documentclass line:
\documentclass[letterpaper,10pt,ngerman]{sphinxmanual}

How can I set this?

juh
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlEzbaAACgkQPUzUEFbILMSe7gCfXEMf3ZrNzi32GlfboL9V0FvG
1qMAoITHfGqVCS4RkDJCagKtwNgRXkh+
=v0li
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] Advocacy article and a question

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Dear list,

never write an advocacy article if you are unsure whether people
should really change their system. ;-)

As self publishing gets mote and more popular by using tools like
Kindle Direct Publishing for ebooks and Createspace for printed books,
people will look for tools that boost their productivity and make
multi channel publishing possible.

I published a couple of ebooks (but only one made with Sphinx) and
more recently I published a book as ebook and printed book.

Multi channel publishing is what Sphinx was built for, so I should
have used Sphinx for this task, but I used two different programs and
two different sources. This is akward, but I had to use Scrivener for
ebook production and LaTeX for print production. Scrivener is a
creative writing tool. It has many output formats, including a perfect
ePub format.

The ePub output of Sphinx is not perfect. And it is not easy to
customize the latex output if you need a special format.

There is a solution for the ebook problem when you use the fork of
Roland Meister (https://bitbucket.org/rolmei/sphinx-epub) which
renders epub much better than stable Sphinx. You can see the result in
my Plone user guide (http://www.hasecke.com/plone-benutzerhandbuch/4.2/)

Now my question:


Does anybody uses the document class scrbook with Sphinx or a very
customized LaTeX format? I would be happy to look into some example
conf.py files with heavy customization to learn how to tweak it.


In spite of these drawbacks I wrote a little advocacy article about
Sphinx, because I think that Sphinx could become a really good multi
channel publishing tool.

http://www.hasecke.eu/Members/juh/sphinx-a-tool-for-self-publisher

But I doubt whether fiction writer without technical background should
use it now. ;-)

Cheers!
juh
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlEzUvMACgkQPUzUEFbILMSvQwCggxzRh3XPDUrymKizSl6uL3IB
DMkAnA55e8ZwS46Czn1iQlLPxyBjJ9FA
=29kv
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] PDF to SVG (was: SVG graphics in html/epub output)

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Am 10.02.13 07:15, schrieb Guenter Milde:
> On 2013-02-08, Jan Ulrich Hasecke wrote:
> 
>> with the figure directive is can insert pdf-files in the latex
>> output and png in the html/epub output
> 
> 
>> .. figure:: ../images/kollektion.* :width: 100%
> 
>> Is it somehow possible to include svg-images in the html and epub
>> output?
> 
> SVG images are supported in Docutils since Release 0.7
> (2010-07-07):
> 
> - Support SVG and SWF images (thanks to Stefan Rank).
> 
> Please try and report problems.

Oh, sorry. I was absent-minded. I should have tested it. It works like
a charm.

SVGs would decrease the size of my user manual considerably.

But it discovered a small issue.

In my user manual I have dozens of screenshots. I use Paparazzi on Mac
OS X to create these screenshots because Paparazzi can make real PDF
files. Every other screenshot programm I know of creates pixel images
even if they put them in a eps or pdf container. So my Paparazzi
screenshots are print ready in any resolution.

With Inkscape I convert the pdf files to svg and I get nearly perfect
vector graphics. Screenshots as real vector graphics! Really nice.

These SVGs are perfectly displayed in my Kindle after converting the
ePub to mobi via Calibre. I cannot test the ePub-output as I have no
ePub-reader.

But the problem is that included pixel graphics in these SVG images
are distorted in the html browser. I tried FF, Opera and Safari. All
the same.

Has anybody encountered something like this?

Are there any tools to batch convert PDFs to SVGs?

juh

- -- 
Demeter und die Allmende des Seins
https://www.amazon.de/dp/B008G4Z2I2
Spekulativer Essay wider die Ahnenlosigkeit und die Anma￟ung des
Eigentums. Eine philosophische Polemik gegen das geistige Eigentum
-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlEXlasACgkQPUzUEFbILMQgWgCgvxmqRXB+HLwW1GQE7NuNd8sd
d+UAn1GFspVqb3W/LQ44r8LgDrjukqbC
=efbx
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.

[sphinx-users] SVG graphics in html/epub output

[Jan Ulrich Hasecke]

-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1

Hi,

with the figure directive is can insert pdf-files in the latex output
and png in the html/epub output


.. figure:: ../images/kollektion.*
   :width: 100%

Is it somehow possible to include svg-images in the html and epub output?

juh

-BEGIN PGP SIGNATURE-
Version: GnuPG v1.4.9 (Darwin)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlEVSB8ACgkQPUzUEFbILMSUKwCdFL6TYu1auOKKSO/jD9v8BooQ
wTIAnRI7UQvzOB+v3mOSmNgiyUlb/CsE
=ISfd
-END PGP SIGNATURE-

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.