Re: [sphinx-users] Using rst file names for navigation

I have been using my own documentation system for years and am writing a program to convert sphinx so that it is easier for others to edit my documentation, and so that I no longer have to maintain it (It was written years ago in C). In this system one has a title and an abbreviated title for

Re: [sphinx-users] Using rst file names for navigation

Stefano David wrote: > HI, > > > On Wednesday, 8 July 2020 13:23:02 UTC+2, bradley...@gmail.com wrote: >> >> I have been using my own documentation system for years and am writing a >> program to convert sphinx so that it is easier for others to edit my >> docume

Re: [sphinx-users] Using rst file names for navigation

Wednesday, July 8, 2020 at 11:24:28 AM UTC-7 bradley...@gmail.com wrote: > I am using toctree in each section that has children as you describe > above. When I view the section with that toctree entry, I would like the > navigation links in the left column to corresponds to the names in t

[sphinx-users] Vertical space after latex command

I like to put macro definitions at the top of my latex files. It seems that sphinx generates empty vertical space when I do this in rst files. Attached is a conf.py and index.rst file that demonstrates this problem: Is there some place I can put a set of latex macro definitions and not have th

Re: [sphinx-users] Vertical space after latex command

Tue, Aug 4, 2020 at 1:41 AM bradley...@gmail.com wrote: > > > > I like to put macro definitions at the top of my latex files. It seems > that sphinx generates empty vertical space when I do this in rst files. > Attached is a conf.py and index.rst file that demonstrates this pr

[sphinx-users] Problem With \newcommand in latexpdf

The index.rst file below demonstrates that \newcommand does not work with latexpdf. Below is my conf.py file # For conf.py documentation see # http://www.sphinx-doc.org/en/master/config # project = 'newcommand' extensions = [ 'sphinx.ext.mathjax', ] ---

[sphinx-users] Re: Problem With \newcommand in latexpdf

other files that get included. I am using the Read The Docs theme and the htm_theme_options has 'titles_only' is set to True. On Thursday, August 13, 2020 at 12:16:22 AM UTC-7 jfbu wrote: > Hi, > > Le 12/08/2020 à 14:19, bradley...@gmail.com a écrit : > > The index.rs

[sphinx-users] latexpdf table of contents and order of text

When generating html files, the information in the current section comes before the information for each of its child sections; i.e., the document is designed to be read from any node down the tree. If I put my toctree commands directly after the title for a section, latexpdf puts the informat

[sphinx-users] make latexpdf

I am trying to figure out how to reproduce make latexpdf with separate calls to first build the latex and then run pdflatex. I want to do this so I can directly modify the latex between the sphinx-build and pdflatex (to accomplish things that are not supported by sphinx). I am using s

Re: [sphinx-users] make latexpdf

. > It invokes pdflatex multiple times automatically. I hope it helps you. > > Thanks, > Takeshi KOMIYA > > 2020年9月13日(日) 6:32 bradley...@gmail.com : > > > > > > I am trying to figure out how to reproduce > > make latexpdf > > with separate cal

Re: [sphinx-users] make latexpdf

The following seems to work for me: rm -r _build sphinx-build -b latex . _build/latex cd _build/latex make .pdf On Sunday, September 13, 2020 at 6:07:07 AM UTC-7 bradley...@gmail.com wrote: > Thanks for the response. I knew one has to run pdflatex twice (when any of &g

Re: [sphinx-users] make latexpdf

command, you can use `make` command under the >> _build/latex directory. >> It invokes pdflatex multiple times automatically. I hope it helps you. >> >> Thanks, >> Takeshi KOMIYA >> >> 2020年9月13日(日) 6:32 bradley...@gmail.com : >> > >> > >>

[sphinx-users] What Sphinx changes on gh-pages branch

I am using sphinx to build my github pages. When a file .rst changes, I get changes in the following files: .doctrees/environment.pickle .doctrees/.doctree _sources/.rst.txt objects.inv .html I like to update my documentation corresponding to the master branch (the bleeding edge) often. This

[sphinx-users] Space Between Italic and Literal Words

Using rst how does one avoid a space between an italic word and a literal word ? The attached rst file demonstrates the problem: -- 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,

[sphinx-users] Re: ANN: "insipid" Sphinx theme, release 0.2.0

I have tried insipid and I have two questions: 1. How does on change the color used for in-line literal font; e.g., ``test`` ? 2. Is there a way to only use titles in the navigation, like read rtd_theme does when titles_only is True; see https://sphinx-rtd-theme.readthedocs.io/en/stable/con

Re: [sphinx-users] What Sphinx changes on gh-pages branch

intermediate file. So they don't need to be committed to your repo. So > please remove them before committing (or give `-d` option to create it > outside of your repo). > > Thanks, > Takeshi KOMIYA > > 2020年10月20日(火) 23:58 bradley...@gmail.com : > > > > I am usin

[sphinx-users] esaping { and } in :samp: role

In the following documentation https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-samp It says: Changed in version 1.8: Allowed to escape curly braces with backslash I therefore expect the input :samp:`\{ {x}, {y} \}' to have the first { in normal font, but in my tests

[sphinx-users] Re: esaping { and } in :samp: role

Sorry for the mistake in the example code, the input should end in a backquote; i.e., :samp:`\{ {x} , {y} \}` On Saturday, November 14, 2020 at 4:35:53 AM UTC-7 bradley...@gmail.com wrote: > In the following documentation > > https://www.sphinx-doc.org/en/master/usage/restruc

Re: [sphinx-users] Problem With \newcommand in latexpdf

and build the pdf ? Perhaps there is a way in preamble.rst to conditionaly include the macros depending on if latex or html conversion is being done ? On Wednesday, November 25, 2020 at 8:34:57 PM UTC-7 ds04...@gmail.com wrote: > On Wed, Aug 12, 2020, 5:19 AM bradley...@gmail.com >

[sphinx-users] Anchors used for links to headings

I want to generate links from web pages that are not generated by sphinx, to headings and sub-headings in web pages that are generated by sphinx. I have noticed that sphinx automatically generates anchors for such links. For example, using sphinx v4.1.2, if the test_link.rst file contains the te

[sphinx-users] theme sidebar configuration

The furo theme (with its default setting) has two side bars. The left side bar contains the contents tree for the web pages. The right side bar contains the contents tree for each individual page. This is a very nice feature because headings within a web page do not affect the overall contents

[sphinx-users] Re: theme sidebar configuration

github.com/executablebooks/sphinx-book-theme/blob/master/docs/conf.py On Sunday, August 21, 2022 at 12:44:43 PM UTC-7 Max Lange wrote: > The sphinx_book_theme > <https://github.com/executablebooks/sphinx-book-theme> supports this. > > On Saturday, August 20, 2022 at 10:00:08 P

[sphinx-users] Re: theme sidebar configuration

the size of the footprint of the documentation. On Sunday, August 21, 2022 at 12:44:43 PM UTC-7 Max Lange wrote: > The sphinx_book_theme > <https://github.com/executablebooks/sphinx-book-theme> supports this. > > On Saturday, August 20, 2022 at 10:00:08 PM UTC-7 bradley...@

[sphinx-users] Re: New PDF builder: Sphinx-SimplePDF

Looks very nice, but it does seems to just display the latex input instead of rending the equations (as intended by latex) ? On Friday, August 26, 2022 at 1:34:13 AM UTC-7 Daniel Woste wrote: > Hi all, > > just wanted to let you know that a new PDF builder is available, which > hopefully makes

[sphinx-users] Re: New PDF builder: Sphinx-SimplePDF

Looks very nice, but it seems to display the latex input instead of rending the equations (as intended by latex) ? Sorry if you got two copies of this post, I was trying to fix a typo in the previous version. On Friday, August 26, 2022 at 1:34:13 AM UTC-7 Daniel Woste wrote: > Hi all, > > jus

[sphinx-users] Fixed Width Paragraph with italic, bold, and normal font

How in sphinx does one create a paragraph that uses a fixed width for all characters and allows one to switch between normal, italic, and bold fonts. This quesiton is similar to the following question on stackoverflow

[sphinx-users] Duplicate target name, cannot be used as a unique reference:

Suppose that the file index.rst contains the text below. This results (for me) in the error message above. In addition the local table off contents has variable_name for the link to the heading variable_name_. Is this expected and if so, how should one document a case like this ? Test Headings

[sphinx-users] Re: Duplicate target name, cannot be used as a unique reference:

It appears that Sphinx does not work with headings that have a underbar at the end ? It this is the case, a better warning message would be helpful. On Friday, September 16, 2022 at 12:08:01 PM UTC-7 bradley...@gmail.com wrote: > Suppose that the file index.rst contains the text below. T

Re: [sphinx-users] Fixed Width Paragraph with italic, bold, and normal font

On Sun, Sep 4, 2022 at 3:27 PM bradley...@gmail.com > wrote: > > > > How in sphinx does one create a paragraph that uses a fixed width for > all characters and allows one to switch between normal, italic, and bold > fonts. > > You should try the parse

[sphinx-users] Could not lex literal_block as "cpp"

Suppose the following file is named soruce/temp.cpp: double f( double x // '(x) ) { return x; } If I put the following command in my sphinx-quickstart source/index.rst file below the toctree command: .. literalinclude:: temp.cpp :language: cpp and I execute the f

[sphinx-users] Re: Could not lex literal_block as "cpp"

The following test indicates this is a problem with sphinx and not pygments. I copied and pastered source/temp.cpp into the pygments Demo https://pygments.org/demo/ with Language C++ and it works fine: On Wednesday, November 16, 2022 at 2:54:14 PM UTC-7 bradley...@gmail.com wrote: > Supp

Re: [sphinx-users] Could not lex literal_block as "cpp"

Thanks: It appears that my system has automatically upgraded to pygments 2.13.0 and the problem is no longer there. On Sunday, November 27, 2022 at 9:47:16 AM UTC-7 je...@abou-samra.fr wrote: > > > Le 16/11/2022 à 22:54, bradley...@gmail.com a écrit : > > Suppose the followin

[sphinx-users] The xrst sphinx wrapper

This is an announcement for the first stable release of xrst https://xrst.readthedocs.io This wrapper was motivated by cases like the GNU Scientific library, which is written in C, uses sphinx for its documentation, and has its documentation in separate files from the corresponding source code.

[sphinx-users] Re: The xrst sphinx wrapper

page (which is no longer there). On Sunday, January 1, 2023 at 10:22:00 AM UTC-7 bradley...@gmail.com wrote: > This is an announcement for the first stable release of xrst > https://xrst.readthedocs.io > > This wrapper was motivated by cases like the GNU Scientific library, which >

[sphinx-users] Re: The xrst sphinx wrapper

x gets the redirect it never reloads it when it changes. I had to clear my cache to get it to reload. On Friday, January 6, 2023 at 5:52:12 AM UTC-7 bradley...@gmail.com wrote: > I changed the name user_guide to user-guide (as a test) and there seems to > be a problem with readthedocs. &g

[sphinx-users] Looking for an example that customizes the sphinx search box

I am looking for an example that customizes the sphinx search. My goal is to only match words that are in the index roles for a page. In addition, I would like all (and only) the index words for each page to be displayed when the matching pages are displayed. Even better would be if the matching

[sphinx-users] Using Sphinx Search

I would like to restrict the search to only match keywords in each page. The keywords in the search box would be separated by spaces with an implicit and between them. The more keywords, the fewer matches. In addition, when I get a match, I would like to see the title (first heading) for the p

[sphinx-users] Re: Using Sphinx Search

I have added the automatic generation, by xrst, of a sphinx web page that does this type of search using raw html and javascript; e.g., see https://xrst.readthedocs.io/xrst_search.html On Wednesday, October 4, 2023 at 8:06:30 AM UTC-7 bradley...@gmail.com wrote: > I would like to restrict

[sphinx-users] Re: Sphinx example sites using Algolia search engine, others?

xrst builds its own search page for each web site it builds; e.g., see https://xrst.readthedocs.io/latest/xrst_search.html What I could not figure out (from the sphinx documentation) was how to replace the normal search with this page ? On Thursday, May 25, 2023 at 5:45:16 AM UTC-7 Mikko Ohtamaa

[sphinx-users] Re: Documentation about the built in search?

I have a sphinx wrapper and wanted to configure the sphinx search to use all the words in the index but I could not figure out how to get sphinx to do this. ( For the sphinx wrapper, the words in the index are the words in the headings, titles, and page names.) I used raw html to get the sear

[sphinx-users] Autonumbering nested lists

This question was asked in a similar from in 2013 and no one replied; see https://groups.google.com/g/sphinx-users/c/Sa8MpXdAQeM/m/TT5DyfwL8O8J The input ``` #. Paragraph one #. Line one.one #. Line one.two #. Paragraph two #. Line two.one #. Line two.two ``` results in the display