[sphinx-users] Sphinx generated pdf documents

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] Integrate documentation into a website with includes

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

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

ically 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 Do

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

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

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

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,

[sphinx-users] Second edition of my Sphinx book

s 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-Dokumentat

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

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?

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

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-

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

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:

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

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

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

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,

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

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

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

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

[sphinx-users] How to deploy the documentation

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

Re: [sphinx-users] math_numfig

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-users] math_numfig

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

[sphinx-users] html_baseurl problems

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

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

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. > >

Re: [sphinx-users] Strange problem with numref

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

[sphinx-users] Strange problem with numref

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

[sphinx-users] coverage

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

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

%} {% 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",

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

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

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

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 st

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

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 w

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

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

[sphinx-users] German Output With lualatex

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} --- >

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

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

Re: [sphinx-users] role any behaviour

ented 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

[sphinx-users] role any behaviour

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

[sphinx-users] numfig_format and translations

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

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

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 >      -

Re: [sphinx-users] sphinx_rtd_theme and topic directive

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

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

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

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

entifier="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

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

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

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

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

Re: [sphinx-users] Sphinx 1.5 released

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

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

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.

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

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 >

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[sphinx-users] literalinclude and long lines

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?

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

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

[sphinx-users] Searching in 600+ files

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

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

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

[sphinx-users] Documenting LaTeX stuff

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

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

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

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

Thanks a lot, I was concerned to hear such an answer. ;-) 2013/11/14 Alex Reinhart alexpoptast...@gmail.com 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

[sphinx-users] Managing big projects

-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

[sphinx-users] geany plugin ?

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

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

-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/

[sphinx-users] Get rid of Release foo bar

-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

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

-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?

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

-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

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

-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