Re: [sphinx-users] iftex.sty is required by not delivered with 1.4.3?

> > -jeff > > > > > > On Tue, Jun 7, 2016 at 11:01 AM, Peter Burdine <pbur...@gmail.com > > wrote: > >> I just upgraded from 1.4.1 to 1.4.3 (running in cygwin). When attempting >> to build a PDF, I am now getting: >> ! LaTeX Error: File `iftex.s

[sphinx-users] iftex.sty is required by not delivered with 1.4.3?

I just upgraded from 1.4.1 to 1.4.3 (running in cygwin). When attempting to build a PDF, I am now getting: ! LaTeX Error: File `iftex.sty' not found. I am assuming it is referring to https://www.ctan.org/tex-archive/macros/latex/contrib/iftex?lang=en. Is this file supposed to be included

Re: [sphinx-users] can I use sphinx as wiki?

If you haven't tried it, you might want to look at the sphinx-autobuild extension. It seems to work pretty well, it will start up its own webserver and issue an html rebuild anytime a file is modified. I have noticed though if you use the sphinx-jinja extension, changing the source of the

Re: [sphinx-users] can I use sphinx as wiki?

. On Thursday, June 9, 2016 at 6:48:15 PM UTC-7, gsavix wrote: > > hhuumm!! good information. please have one url for all of us see more > details? regards. > > 2016-06-09 15:56 GMT-03:00 Peter Burdine <pbur...@gmail.com > > : > >> If you haven't tried it, you might wan

[sphinx-users] Re: parsed-literal/code-block and other preformated block in PDF Output

I guess this is a feature "by design": > (DefaultSubstitutions won't help, since these are used as Text nodes as > well.) > >From https://github.com/sphinx-doc/sphinx/issues/2173 On Monday, May 16, 2016 at 4:52:21 PM UTC-7, Peter Burdine wrote: > > I think

[sphinx-users] Re: Help changing title of the index.html

Look at your index.rst, it should be the first header in there. On Wednesday, June 15, 2016 at 12:18:05 AM UTC-7, Protik Das wrote: > > > Hi everyone! I am trying to design my homepage > which is primarily going to be > documentation of a tool named VASP. As it is

Re: [sphinx-users] iftex.sty is required by not delivered with 1.4.3?

I'm sure everyone figured this out, but this was fixed in 1.4.4. On Tuesday, June 7, 2016 at 3:40:27 PM UTC-7, Peter Burdine wrote: > > For now, I've downloaded the iftex.sty from the above referenced site and > added to the latex_additional_files list in the conf.py. That seems to

[sphinx-users] Re: absolute path from Root to import image

I don't think this works. See the thread here about documents outside of the "root" directory. https://groups.google.com/d/msg/sphinx-users/7k6YJ7-t5BY/32h7NWegHgAJ "ImportError messages when running "make html" when the source files are located in a different folder than sphinx's" --Peter

[sphinx-users] Re: parsed-literal/code-block and other preformated block in PDF Output

I think this is related to https://github.com/sphinx-doc/sphinx/issues/2167 that Andrea put in last year. On Saturday, May 14, 2016 at 10:27:47 AM UTC-7, Peter Burdine wrote: > > Is there a way to either completely enable or disable syntax-highlighting > for parsed-literal and code-b

[sphinx-users] Re: TOC Depth in HTML vs PDF -- PDF output has numbered headings up to level 3

I figured out that Sphinx defaults to 3 levels for PDF. If you want more you need to include something like this in your preamble: \setcounter{secnumdepth}{9} > On Saturday, May 14, 2016 at 3:31:52 PM UTC-7, Peter Burdine wrote: > > I'm trying to write a document using the 'manua

[sphinx-users] parsed-literal/code-block and other preformated block in PDF Output

Is there a way to either completely enable or disable syntax-highlighting for parsed-literal and code-blocks? I am running into an issue where I have to use parsed-literal directives because I need some formatting in code blocks to show which words are variables, eg something like this: ..

[sphinx-users] TOC Depth in HTML vs PDF -- PDF output has numbered headings up to level 3

I'm trying to write a document using the 'manual' format. In my main TOC, I've tried setting :maxdepth: as high as 15, but in the PDF output it only creates numbered headings for the first 3 levels. All level 4 headings and below are no longer numbered. The heading in the HTML output are

[sphinx-users] How can I get headers/footers on the title page in latexpdf output

How can I get headers/footers on the title page in latexpdf output? I've been able to modify - \fancypagestyle{plain} - \fancypagestyle{normal} to get the headers/footers of the rest of the pages working, but for the life of me, I can't get any headers/footers to show up on the title

[sphinx-users] Re: ImportError messages when running "make html" when the source files are located in a different folder than sphinx's

>From my research it doesn't appear that this works in Sphinx. What you can do though is create links or junctions under your source directory to make it look like source files are in a subdirectory of your project. That will allow Sphinx to consume them. You have to have admin rights in

[sphinx-users] Re: ImportError messages when running "make html" when the source files are located in a different folder than sphinx's

I ran into the same issue. The consensus I found was that it isn't supported. If you run on UNIX-ish systems, you can use symlinks then it will be happy. On Windows, you can kind of do the same thing, Unfortunately, you need admin rights to make links on Windows, but you don't need admin

[sphinx-users] Re: rst_epilog, replacing text, ifconfig, dealing with environmental variables.

For the documentation I have been writing, I couldn't get ifconfig or replacements to do what I wanted do. I have some variation on how things work and ifconfig was pretty limited. I didn't like replace either because it make it difficult to use it in directives. Eg: .. parsed-literal::

Re: [sphinx-users] genindex in latexpdf

That is exactly how I handle it as well: .. only:: html - Indexes - * :ref:`genindex` * :ref:`search` On Wednesday, August 10, 2016 at 5:53:14 PM UTC-7, Paolo Cavallini wrote: > > Il 28/07/2016 12:38, Paolo Cavallini ha scritto: > > > Issue found

[sphinx-users] Re: How to use multiple paths for python modules documentation in different directories using sphinx autodoc?

Have you tried changing your sys.path to include both? Eg: sys.path.insert(0, os.path.abspath("..")) Then for autodoc tried: .. automodule:: python_modules_A .. automodule:: python_modules_B How you include documentation for it may then depend on your module structure (eg do you have an

[sphinx-users] Re: export individual pdf to each rst file

If you really wanted to do it with Sphinx, then you need to modify the latex ouput. In your conf.py there should be a section with the following comments: # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto,

[sphinx-users] Re: Display section number in reference?

https://github.com/sphinx-doc/sphinx/issues/326 On Wednesday, August 24, 2016 at 11:25:17 AM UTC-7, Jason S wrote: > > +1 > > On Wednesday, June 10, 2015 at 4:12:50 AM UTC-7, Andrea Cassioli wrote: >> >> Hi, >> I am struggling to find a simpler workaround that using a custom >> extension for

[sphinx-users] Re: Role functions have an inliner, how do I get it from within a Directive?

import sphinx from docutils import nodes from docutils.parsers.rst import Directive from docutils.parsers.rst import directives from docutils.statemachine import ViewList class CustomDirective(Directive): has_content = True required_arguments = 1 option_spec = { }

[sphinx-users] Re: Custom JSON output?

Can you describe your starting point and goals a bit more? It looks like you may be trying to autodoc source code in json format? If that is the case, then you might want to look at the source for the napolean extension (well, it is built into sphinx now).

[sphinx-users] Re: Sphinx PDF themes

For Sphinx, most people create a preamble.tex file that modifies the formatting Sphinx uses. As of 1.4.x of Sphinx, there isn't much in the way of global styling options. You have to learn a bit of Latex. On Thursday, October 6, 2016 at 5:32:08 AM UTC-7, Minkai Li wrote: > > Does the Sphinx

Re: [sphinx-users] Re: Sphinx PDF themes

ed, 26 Oct 2016, Peter Burdine wrote: > > > The following worked fine for me: > > .. tabularcolumns:: |>{\RaggedRight}p{\dimexpr > 0.3\linewidth-2\tabcolsep} > > |>{\RaggedRight}p{\dimexpr > 0.4\linewidth-2\tabcolsep} > >

[sphinx-users] Re: Creating a foreword

I think the root cause of this issue is the way the builders approach the documents. HTML is a straight forward 1:1 translation, the latex builder kind of does the same thing. The issue is that it is LaTeX that builds the table of contents and other front matter for the document (with the

[sphinx-users] Re: how do I add subtitle?

(conf.py?) > > On Wednesday, 12 October 2016 17:33:08 UTC-7, Peter Burdine wrote: >> >> Can you clarify what you mean by "subtitle"? >> >> The reST you posted (assuming it is all in one file) says make a Heading >> 1 ('Title'), followed by a Heading 2

[sphinx-users] Re: sphinx pdf style

The short answer is not in 1.4.x. It looks like 1.5.x may have a little, but nothing as easy as CSS. Start by reading through the sphinx.sty file (found in your latex build directory) to give you an idea of what you are dealing with. It looks like you have made 6 threads all with basically

Re: [sphinx-users] Re: Sphinx PDF themes

. On Oct 24, 2016 4:40 PM, "Warren Block" <wbl...@wonkity.com> wrote: On Mon, 10 Oct 2016, Peter Burdine wrote: Sphinx tables in latex are inconsistent at the moment. There is a ticket > open to use just one package for tables, but right now I think it picks 1 > of 4(?) pack

Re: [sphinx-users] Re: Sphinx PDF themes

n Tuesday, October 25, 2016 at 3:48:21 PM UTC-7, Warren Block wrote: > > On Tue, 25 Oct 2016, Peter Burdine wrote: > > > > > Please post the tabularcolumns directive you are using and enough of the > table definition to see the first header row. There isn't enough in

[sphinx-users] Re: Sphinx PDF themes

work. > > > 在 2016年10月7日星期五 UTC+8上午8:23:47，Peter Burdine写道： >> >> For Sphinx, most people create a preamble.tex file that modifies the >> formatting Sphinx uses. As of 1.4.x of Sphinx, there isn't much in the way >> of global styling options. You have to learn a

[sphinx-users] Re: how do I add revision history table?

In the latex output, all of the front matter ouput (title page, toc, etc) is controlled by the \maketitle command. If you want to change the front matter you need to renew that command to change its behavior. On Friday, October 14, 2016 at 4:41:39 PM UTC-7, Fiona Hanington wrote: > > Hi there

[sphinx-users] Re: Adding background color of notes and attention to Sphinx-generated PDF files

notes" to have a background color. Using the above, you should be able to figure out the other admonitions. Note that this is only one method of doing it, I'm sure there are others. On Wednesday, October 12, 2016 at 5:33:15 PM UTC-7, Peter Burdine wrote: > > This is where you nee

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

This was discussed in the last 2 weeks. Please see these threads: https://groups.google.com/forum/#!topic/sphinx-users/S_ip2b-lrRs https://groups.google.com/forum/#!topic/sphinx-users/FpbnecT7qus Please review those. I believe there is enough information in those threads since they were

Re: [sphinx-users] Re: Actual, working example of latex-pdf cover page?

:: latex directives. If you go that route and it works, please let me know. On Tuesday, December 20, 2016 at 7:03:13 AM UTC-8, Warren Block wrote: > > On Mon, 19 Dec 2016, Peter Burdine wrote: > > > Yes, that is exactly why it is setup that way. Remember that it is only > pa

[sphinx-users] Re: Why does this warn? ":ref:" inside ".. only::"

Pete, I may be a bit off on this, but I think the error is coming out during the resolving phase not the writing phase. See http://www.sphinx-doc.org/en/stable/extdev/tutorial.html I believe the HTML builder works mostly in phase 4 and it may be some other process trying to do the resolving

[sphinx-users] Re: Parsing inline literals

There are two other approaches that may work for you that I have used or seen people use: 1) Pass it through a pre-processer first to do replacements like that 2) Look into the jinja extension. In both cases the variables will be be replaced before docutils sees the reST. On Friday, April

[sphinx-users] Re: Relative paths - File not readable

We have to do this a lot since we have a library of sections that may need to be included in various documents. We handle it by creating a "links" file that contains relative paths of links that it should create under the source directory. Then we modified the make file to run a script that

[sphinx-users] Modifying a document in the 'env-updated' event

I have an extension that followed the todo example, which works great when the output is latex, but for HTML it doesn't work right. The reason for this seems to be that we are using Sphinx for a modular documentation project so not all of the files will be included in the output. When using

[sphinx-users] Re: Set background color for block of parsed text for pdflatex output

For PDF output, the "easiest" way is add a latex preamble that redefines the style. The style names sometimes change from version to version (eg, I'm still on 1.4.4, I know they are different in 1.5). I store the premble in a .tex file outside of the conf.py, like so: PREAMBLE =

[sphinx-users] Re: How to number admonitions?

You can create serial numbers using env.new_serialno('your_string_here') It should create a unique incrementing number for each string you give it. So if your wanted to create a special admonition, it would be: env.new_serialnl('special_admonition') This would go in your directive's run

[sphinx-users] Re: Factoring toctree Stanzas?

I didn't make a test case, but we have found (with at least Sphinx 1.4.x) you can't always have the same file in two different tocrees go into the same document. The behavior tends to be build specific. For example if you included bar in both toctrees (without using :hidden:) and the first

[sphinx-users] Re: How to namage big document . How to have a list of pages ?

The issue you are seeing is that you are linking to it via a hyperlink instead of including it in a toctree. Thus it may work for the html builder, but if you output into latexpdf/epub/etc, your document will not work as expected. If that is OK with you, then you can add the text as the

[sphinx-users] Re: Specifically wrapped function & automodule

IIRC the current versions of Sphinx/Autodoc don't work well with decorated functions. Try adding the actual function signature as the first line in the doc string. Eg: @Operation.register('foo') def func(arg): """func(arg) Documentation of decorated function""" pass

Re: [sphinx-users] cross referencing autonumbered list items

Since this is reST, you need to be careful with line numbers. To make autonumbered sub-items, you just need use the normal auto number (#.), but have blank lines and indentations around each level change, eg: #. An Item #. A Subitem #. A subsub item #. Another subsub item #.

[sphinx-users] Re: Tweaking automatic section numbering?

What is your desired output? We do all of this in Latex, it requires adding a bit of LaTeX in your preamble. On Friday, October 13, 2017 at 7:29:52 AM UTC-7, Matthew Woehlke wrote: > > I filed this also as an RFE¹ but haven't gotten any feedback so far; > trying here instead. > > What would

Re: [sphinx-users] Re: master_doc variable doesn't influence html/latex builders

, Dessus Ph. <pdes...@gmail.com> wrote: > thx Peter, > 1. Sphinx can run pretty well on Windows, AFAIK. Follow the install > instructions. > 2. Good idea; a bit tricky, but I'll try it. No more elegant solution ? ;-) > best, > ph > > > Le vendredi 1 septembre 2017 16:3

[sphinx-users] Re: Using variables inside code block and httpdomain directives

A code block isn't parsed. If you want Sphinx to process it, you need to use a parsed-literal. This also comes with all the downsides of being parsed, escaping, markup, etc. I don't know about the http directive. Depending on how much you need to do, you may want to look at the jinja

[sphinx-users] Re: How to use substitution in code-block with code highlight

Or you can use another directive do the replace first, then process the code block. We use the Jinja extension to do this on a regular basis. Note that we are still using Sphinx 1.4.x and highlighting only works for HTML, it does not highlight in PDF output. I do not know if it has been

[sphinx-users] Re: Help need for latex output

Also, see this older discussion: "Actual, working example of latex-pdf cover page?" https://groups.google.com/forum/#!topic/sphinx-users/S_ip2b-lrRs It has some other examples found on github and some additional discussion. --Peter On Friday, December 29, 2017 at 6:04:06 AM UTC-8, Rene

[sphinx-users] Re: How to align LaTeX PDF tables left again

You have to use the tabularcolumns directive, which can take a ton of latex commands for formatting of columns, such as: .. tabularcolumns:: |>{\RaggedRight}p{\dimexpr 0.3\linewidth-2\tabcolsep} |>{\RaggedRight}p{\dimexpr 0.45\linewidth-2\tabcolsep}

[sphinx-users] Re: Help need for latex output

I haven't used the Jypyter notebook extension, but I would assume it is the same process. You need to include a LaTeX preamble that overwrites various macros predefined by Sphinx. I haven't updated to 1.5 yet (still on 1.4). Update your conf.py to specify a preamble: PREAMBLE =

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

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

[sphinx-users] Re: How to install on machine with no internet access

On an internet connected machine run: pip download --process-dependency-links --disable-pip-version-check -d sphinx_install sphinx Where sphinx_install is the directory where you want to store the files you are downloading. Then transfer that directory to a non-internet connected machines and

[sphinx-users] Re: explain "updating environment" please

It may depend on what extensions you have running. Those may flag ALL files as being changed so the extension can reprocess them. --Peter On Wednesday, October 3, 2018 at 8:22:02 AM UTC-7, ryanwist wrote: > > Hi Paul, > > Thanks for the reply -- good to have pointers on where to look. I can

[sphinx-users] Re: Get full documentation tree

See: https://groups.google.com/forum/#!msg/sphinx-users/0UW05Inwfac/X8bCZmlLBwAJ This is what I did a few years back. The builders are inconstant when they create events and I haven't been able to figure out how to make it work either. I have an extension that followed the todo example, which

[sphinx-users] Re: :doc: in a custom directive

Hmm, I don't use self.state.nested_parse, this is how I've done it: sphinx.util.nodes.nested_parse_with_titles(self.state, ViewList(new_content. splitlines(), source=docname), node)

[sphinx-users] Re: Advice on finding a Sphinx consultant?

Doh! I meant *lack* of responses. On Monday, May 13, 2019 at 7:23:57 AM UTC-7, Peter Burdine wrote: > > I believe at one point in time they were actively discouraging advertising > of services on this group, even when related, which is probably one of the > reasons for the lake

[sphinx-users] Re: Advice on finding a Sphinx consultant?

I believe at one point in time they were actively discouraging advertising of services on this group, even when related, which is probably one of the reasons for the lake of responses. On Friday, January 29, 2016 at 1:35:45 PM UTC-8, Chris Chang wrote: > > We're looking to revamp our

[sphinx-users] Re: Sphinx Active Directory / LDAP integration

Sphinx isn't a web server or any other server. If you are going use it to generate a knowledge base, then you are going to need another tool (web server, network share, confluence, etc) that is responsible for the protection you are looking for. Someone may be able to offer some

[sphinx-users] Re: Prevent documentation of infinite loops

I don't believe Sphinx (by default) uses while loops. Are you writing your own extension or using an installed extension? We've had an issue like this in the past when using jinja. Is that what you are talking about? On Monday, July 22, 2019 at 1:57:46 AM UTC-7, József Pohl wrote: > > Hi, >

Re: [sphinx-users] Re: Prevent documentation of infinite loops

Is your code protected by: if __name__ == "__main__": main() If you dont have something like this, your code will be executed when the files are exec'd to get the doc strings. On Tue, Jul 30, 2019, 13:34 Peter Burdine wrote: > I don't believe Sphinx (by default) uses while lo

[sphinx-users] Re: Documenting + consolidating multiple repos/directories into one searchable html output

They way we have done this in the past is to link (eg ln -s) all of the other repos into your source directory, then perform a build. On Friday, October 4, 2019 at 2:57:07 PM UTC-7, Nicholas Yue wrote: > > Hi, > > I have success documenting individual repo/directory > > However, I would like

[sphinx-users] Re: automatically, the address is replaced with 'html#id1' like this.

You *could* make it do that, but then you would make making your own anchors for each section: .. _1101: 1101 ..raw:: html :file: _static/1101.html On Tuesday, February 11, 2020 at 6:33:04 PM UTC-8, Orang Gendut Korea wrote: > > Hello~! > > I'm migrating our local html file to

[sphinx-users] Re: best wiki to produce documentation

Are you asking to go from Sphinx -> Wiki? If so you can use the confluence builder: https://github.com/sphinx-contrib/confluencebuilder Or are you asking to get documentation from a Wiki and then have Sphinx do something for it? On Thursday, February 20, 2020 at 3:56:26 AM UTC-8, Renato

[sphinx-users] Re: parse generated output from program

Make your own directive that runs your command. You can probably use the programoutput extension code as a reference for how to make the directive. Then use the nested_parse_with_titles function: from docutils import nodes from docutils.statemachine import ViewList def run(self):

[sphinx-users] Re: Discover new Document on a Subdir

Marco, Are you looking for globbing in the toctree? Eg: .. toctree:: :glob: DIR1/* DIR2/* DIR3/* This will include ALL the files from DIR1 (sorted in alphanumeric order) then DIR2 then DIR3, etc. --Peter On Thursday, April 23, 2020 at 7:11:49 AM UTC-7, Marco Longo wrote: