Questions tagged [sphinx]
Sphinx is a documentation generator which converts reStructuredText files into several formats, including HTML, LaTeX, PDF, EPub and man.
45
questions
0
votes
0
answers
49
views
Sphinx Verbatim (Code block) inside mdframed environment
My code-block don`t break on new page when a use code-block inside mdframed environmen:
\begin{mdframed}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
Tablespaces:
PRIMARY (1)
Full path: /home/test/...
0
votes
0
answers
33
views
How to link orphan files from a source file in generated pdf file
In my documentation project, I am intending to make use of both HTML and pdf documents. As my project has gone quite unwieldy, I have started to store some of the data / information in separate files ...
- 111
0
votes
0
answers
40
views
Adding JQuery icon sets to LaTeX documents
I have found multiple references to adding TeX to JQuery-enabled things, and a simple search found plug-ins for inserting LaTeX equation builders into JQuery but I don't think I've seen questions in ...
- 13
-1
votes
1
answer
65
views
How to assign a background color to an arbitrary command? [closed]
When using custom roles, Sphinx will generate a LaTeX that looks like this
\sphinxAtStartPar
\DUrole{customroleone}{This is under custom role 1}
\sphinxAtStartPar
\DUrole{customroletwo}{This is under ...
- 141
0
votes
0
answers
108
views
Using Sphinx, how can I tell LaTeX to not process emojis?
I'm facing errors converting a Sphinx project (read the docs style documentation).
! Package inputenc Error: Unicode character 🚚 (U+1F69A)
(inputenc) not set up for use with LaTeX.
...
- 101
1
vote
1
answer
237
views
how to use a webfont in a Sphinx build environment?
I'm building an extension for sphinx to include fontawesome icons inside documentation. It would be great if it could work in the LaTeX build as well. My initial work was relying on the "...
- 129
1
vote
1
answer
183
views
How to add tikz images to a latex document created via sphinx
What is the best way of adding tikz images to a latex document created via sphinx. Is there some kind of specific library
- 51
0
votes
0
answers
129
views
Japanese Unicode characters not printing in Sphinx Simple-PDF
I am a newbie in Latex. I am using sphinx-intl to generate my .po files and sphinx-simplepdf extension to generate the PDF.
My Sphinx conf.py is :
locale_dirs = ['locale/'] # path is example but ...
- 1
1
vote
1
answer
3k
views
How to install the full TexLive on Centos 7
I am trying to make some documentation using Sphinx, and packages are continually missing. I have tried installing the full version, however, I must have failed since, despite being over 450 MB, I am ...
- 123
1
vote
0
answers
195
views
How do I use nicematrix package in Sphinx documentation?
I'm trying to incorporate nicematrix functionalities into my Sphinx documentation. I have MiKTeX and I've intalled the nicematrix package.
In my conf.py file, I added this:
latex_elements ={'preamble'...
- 11
3
votes
2
answers
2k
views
Custom header design for sphinx generated document
I am trying to make a custom header design working in our generated sphinx documentation.
The black triangle has to touch the line.
The result should look like this:
My best result in LaTeX looks ...
- 141
1
vote
0
answers
634
views
Styling sphinx LaTeX tables with booktabs package
I am trying to improve the look of LaTeX tables generated from Sphinx. In particular, I'd like to use the booktabs top, mid, and bottom rules and suppress vertical cell separators.
This rST table:
+---...
- 301
2
votes
1
answer
1k
views
Box chars characters (Missing character: There is no ┬ in font)
I am using Sphinx to build a project that use listings and some box characters. I have these errors:
Missing character: There is no ─ in font [lmmono9-regular]:!
Missing character: There is no ┬ in ...
- 1,615
0
votes
1
answer
167
views
How to determine the options available in the second parameter of latex preamble /DeclareUnicodeCharacter
Context
I am using Sphinx and latexpdf to build reStructured documentation for my project. The documentation draws in remote data that it cannot control (only escape/parse etc).
My current build ...
0
votes
1
answer
176
views
Latex not finding image files, appears they have extra quotes in the name
Using sphinx-1.8.5 with mactex 2019. The original rst is
.. _cylindricalcapacitorsetupwin:
.. figure:: cylindricalCapacitorSetupWin.png
:align: center
:alt: figure 1
:width: 90%
Setup ...
- 31
1
vote
1
answer
1k
views
Sphinx Verbatim (Code block) with background color
I would like to remove the frames and set a light grey shade background to my code blocks.
I know I could use colorbox such as \begin{tcolorbox}, but I have no idea where to place it.
Sphinx uses ...
- 1,615
0
votes
1
answer
102
views
meaning of \cite{../foo/bar:baz} in sphinx-generated LaTeX
Trying to debug (after update to sphinx 1.8.5 from 1.7) documentation biulding produced by sphinx, we see in generated LaTeX files calls to \cite
with an argument involving a path to a file, like
\...
- 236
1
vote
1
answer
113
views
Broken build if a too big picture is included in a framed environment, how to insert "horizontal slices" rather?
This produces about 5000 pages before crashing:
\documentclass{article}
\usepackage{framed}
\usepackage{graphicx}
\begin{document}
\begin{framed}
\noindent\includegraphics[height=35cm]{example-...
user4686
1
vote
1
answer
2k
views
Custom color for LaTeX output in Sphinx documentation package
I am trying to customize the color of the LaTeX inline formula when using Sphinx documentation package, and html output.
The details:
I have a file called func.rst, which includes the following line:...
- 235
-1
votes
2
answers
591
views
How do you set max row height in tabulary
Ok, so I'm working with a sphinx-generated latex document and I'm trying to fix some of the rather ugly code - and generated output. I've got a table that doesn't split when it gets to the end of the ...
- 46
0
votes
1
answer
550
views
Custom command to configure table style
I'm using sphinx to generate our company manuals. In our legacy manuals we have a certain table style, that we would like to keep.
The table style consists of tables having a header with dark green ...
- 101
4
votes
1
answer
587
views
add single kanji characters
I am a little lost adding a few (<10) kanji characters to my document.
I am using current sphinx and mactex installations. The document builds fine using DeclareUnicodeCharacter statements in the ...
1
vote
1
answer
759
views
Add page break after tableofcontent via preamble?
Is it possible to add a page break after the table of contents in the preamble rather than inline in the .tex file?
This question is somewhat related to the other one I asked here, though since it's ...
- 151
3
votes
1
answer
834
views
Include title page in numbering via preamble settings only?
I'm trying to make my title page count as "Page 1" in my PDF, but I have the restriction that (I think) I can only make a change to the preamble section of my .tex file.
My scenario is that I'm using ...
- 151
5
votes
1
answer
1k
views
What is the purpose of sphinx.sty and sphinxmanual.cls
I use sphinx to generate my PDFs, and I do not know what is the purpose of sphinx.sty and sphinxmanual.cls? Can I modify the two files?
- 61
1
vote
0
answers
977
views
Use sphinx to convert Latex,How to set the tableheader color?
I use sphinx to generate pdf, But I want to set the tableheader color? How to set?
The tables it produces via latex are pretty ugly, so I'd like to give them some global styling. What I'd like to ...
- 61
0
votes
1
answer
419
views
Failing to translate the Number of the chapter with Babel [closed]
I'm using sphinx and latex to generate my documentation.
I need to translate the document in another language and I use tha package babel (added to the conf.py file).
While babel translates ...
- 123
1
vote
1
answer
654
views
Delete **Contents:** in index of pdf generated with python-spihnx
I have a project created with python-sphinx and I use latexpdf to compile the final pdf.
In the final pdf created, in the index it is visible a Contents: string that I would like to delete.
The only ...
- 123
4
votes
2
answers
3k
views
Override table in sphinx
I'm using sphinx to generate documentations. The tables it produces via latex are pretty ugly, so I'd like to give them some global styling. What I'd like to achieve is
Always 100% width
A header row ...
- 215
3
votes
1
answer
2k
views
Include Sphinx-generated documentation in master file
I'm currently working on a project (for university) that will be documented with LaTeX. About one third of the documentation will be about a python module that I've written.
I'm looking for a clean ...
- 235
3
votes
1
answer
6k
views
Argument of \@item has an extra }
I get the error
! Argument of \@item has an extra }.
<inserted text>
\par
l.135 \emph{class} \bfcode{C}}
when translating a LaTeX file generated by Sphinx documentation ...
- 1,762
1
vote
0
answers
532
views
Setting default image dpi using sphinx and texi2pdf
In QGIS project, we are using Sphinx to create our documentation as HTML and PDF. We are having a bit of a problem with figures as they show a bit blurry in PDF. I found out that the reason is ...
3
votes
2
answers
822
views
Tikz + Verbatim + Sphinx , output drawn twice with slight offset. Works great Tikz + Verbatim
I'm working on a piece of software that outputs IPython Notebooks as tex documents. One of my requirements is to be able to draw code input output blocks that look like the Notebook's UI.
Disclaimer:...
- 33
4
votes
1
answer
2k
views
Including .tex files that need a different style file than the main text
EDIT: Substantial edit of the original version has been done to clarify the question.
Background
I've written two small python package manuals with sphinx (http://sphinx-doc.org/) a program that ...
- 429
3
votes
2
answers
4k
views
Writing conditional equations with braces in sphinx
I want to write conditional statement with one-sided curly brackets in Sphinx as shown below:
In Latex, the best I could do is given below:
\[
x = \begin{cases}
\begin{split}
d&...
- 241
2
votes
1
answer
1k
views
error on generating pdf by Latex with CJK support
After adding unicode characters to \title{} micro:
\title{标题}
the following error occurs when running make all-pdf with a .tex file:
Writing index file mybook.idx
No file mybook.aux.
(/usr/share/...
- 213
4
votes
1
answer
2k
views
How to modify the default LaTeX package parameters of Sphinx?
I want to generate pdf by using Sphinx. Sphinx generates pdf through LaTeX. But I have to add unicode=true to package hyperref of LaTeX:
\usepackage[unicode=true]{hyperref}
But Sphinx has generated ...
- 213
3
votes
1
answer
282
views
Inter-word spacing issue with long code tags
I'm having an issue with the Sphinx Documentation Generator, you may be asking what this has to do with LaTeX. Well, we were hoping to use it for our specification documentation which needs to be ...
- 133
5
votes
2
answers
5k
views
Sphinx: Overriding the document class
I am using Sphinx to generate multi-output documents (Epub, HTML, LaTeX). How can I change the use documentclass?
The following snippet should (in my opinion) override the used class but results in
...
- 13.3k
4
votes
1
answer
3k
views
Changing fonts for heads and subheads in Sphinx LaTeX
In pdf export the AvantGarde font is used a lot for heads and subheads. I would like to use a modern font like Helvetica. Is it possible to just exchange AvantGarde with Helvetica.
If possible I ...
18
votes
2
answers
8k
views
Set standard default scaling of \includegraphics
I am using Sphinx and the plantuml package to include UML diagrams.
The plantuml package for Sphinx generates the following LaTeX code:
\includegraphics{%s}
Anyways - the diagrams are to big, so ...
- 281
1
vote
1
answer
2k
views
Override global page style? [duplicate]
Possible Duplicate:
Change paper size in mid-document
How can I use default
\documentclass[a4paper]
styles in Title page, index pages, header and footer - but the text itself as if I were ...
- 3,037
6
votes
1
answer
6k
views
How to make latex recognize tick and cross symbols
I'm looking for a way of making latex recognize the tick and cross symbols as apposed to having to use commands in latex code to make these symbols. Is there anything you can add in the preamble that ...
- 267
1
vote
1
answer
2k
views
Sphinx in-line math equation alignment
As suggested by the answer to my question here, I am using the Sphinx tool in order to multi-target PDF and HTML output. For HTML, I'm using the pngmath extension.
The vertical alignment of inline ...
- 3,701
10
votes
3
answers
7k
views
How to use Unicode characters with Sphinx rst documents and properly generate PDF files?
I discovered that if I use some Unicode characters inside .rst files, I will loose them when I convert the documentation to pdf using Sphinx.
Example chars: "șț".
When I run make latexpdf I get a ...
- 201