python-sphinx Questions
2
Solved
I have made a sphinx project/documentation (using the alabaster theme) that has a fixed sidebar on the left (containing the TOC), but has too much content to display on the screen. How can I make t...
Crescentic asked 14/7, 2019 at 23:20
5
I downloaded the read-the-docs theme for sphinx from Github and put it into the _themes folder.
conf.py:
html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]
However...
Nor asked 16/9, 2021 at 9:49
3
Solved
I want to use Sphinx's autosummary extension and templates to generate API docs recursively from docstrings. I want separate pages for each module, class, method, property and function. But it does...
Kessiah asked 3/1, 2018 at 8:57
2
I am using Sphinx tool for documentation and ran into a situation where I want to expose a piece of information in only one file format.
I came across this link which addresses a similar issue with...
Leahy asked 14/3, 2017 at 23:2
5
Solved
I've been getting warnings in my documentation builds of the variety "Title level inconsistent". As far as I can tell, I have a consistent structure that looks something like:
Big Title
=========
...
Amoakuh asked 1/7, 2014 at 7:5
3
I'm struggling with sidebar table of contents in Sphinx's generated documentation.
I just want to have kind of automatically generated index tree by the left side of my documentation. Instead, I s...
Abiogenetic asked 12/12, 2018 at 14:32
2
Solved
I have many .rst files in my Sphinx tree which are intentionally excluded from any index tree. I get warnings like
/filename.rst:: WARNING: document isn't included in any toctree
How can I supp...
Gavelkind asked 17/10, 2012 at 9:23
10
Solved
I've been documenting a software package using Sphinx and reStructuredText.
Within my documents, there are some long code snippets. I want to be able to have them hidden as default, with a little...
Looney asked 16/3, 2010 at 13:19
2
I am using Sphinx to create this table:
+---------------+---------------------+---------------------------+-------------------------------------+---------------------+
| Stakeholder | Major Value ...
Vanettavang asked 18/12, 2014 at 12:34
2
Solved
I'm using sphinx and RST to generate some tech documentation as HTML and having issues getting a local PDF reference to work as a hyperlink. I've seen people use :download: to link to local PDFs, b...
Scale asked 27/7, 2016 at 12:57
2
Solved
I'm building an HTTP API and I factored out a lot of code into a superclass that handles requests to a collection of objects. In my subclass, I specify what database models the operation should wor...
Purvis asked 16/8, 2016 at 1:12
11
Solved
I am using 'Read the Docs' Sphinx theme for my documentation. In the original theme, given below
Read the Docs Sphinx Theme
the content or main layout width is designed to be mobile friendly. Howev...
Hurter asked 22/4, 2014 at 6:9
2
Solved
I have a toctree in my index.rst that looks something like this:
.. toctree::
:maxdepth: 2
cat
dog
moose
I am looking to to nest the contents of my toctree similar to how it is done here wi...
Extradition asked 28/4, 2016 at 21:34
2
Solved
I am trying to place a bulleted list in my reST simple table, but each line of the bulleted list gets its own row:
====================== ======================= =======================
|foo.png| ...
Dalia asked 29/8, 2013 at 22:56
1
Documenting a Python module using the numpy style and generating html documentation using sphinx and the numpydoc extension, I stumbled upon a bug (or feature?) regarding bulleted lists.
In reStruc...
Germicide asked 13/7, 2016 at 9:39
2
Solved
In Sphinx, file links can be generated using the following syntax:
`name_of_file.js <some/location/name_of_file.js>`_
In the conf.py file, a version variable is defined that we can use in ...
Schaffer asked 18/6, 2015 at 16:33
1
I inherited an existing RST document with the following structure:
DocTitle
========
Heading2
--------
Heading1
========
Note that Heading1 is a larger heading than Heading2. Due to the fact t...
Leptosome asked 25/6, 2018 at 21:1
4
Here is a solution for the same problem:
Open a link in a new window in reStructuredText
However, when the document has a lot of links (especially when the links are in a table), this solut...
Belva asked 30/8, 2014 at 14:44
2
Solved
In Markdown, one can create an inline code link like so
[`dict.update`](https://docs.python.org/3/library/stdtypes.html#dict.update)
Which renders like dict.update. How can get a similar behaviour...
Quathlamba asked 11/5, 2021 at 9:57
3
Solved
I generate a documentation from rst to pdf with latexpdf and sphinx.
How can I add some page break (=new page) in my PDF?
For now I use PageBreak but it only work with rst2pdf.
.. raw:: pdf
Pa...
Propene asked 30/9, 2014 at 12:12
2
Solved
I am using Sphinx for documenting a Python project and would like to have content from an existing .md file display inside of a .rst file.
( I have already set up my conf.py to allow for markdown)....
Petrography asked 30/8, 2017 at 18:7
2
Solved
In python-sphinx there is the only directive, which can be used to conditionally influence the document according to its output. For instance text appears in html or latex only.
It is use like thi...
Baucom asked 12/4, 2015 at 12:39
4
I'd like to link to some URL in my Sphinx docs:
<a href="http://some.url">blah</a>
I have found something similar in the docs: http://sphinx-doc.org/ext/extlinks.html - but i...
Uppermost asked 19/6, 2013 at 10:35
6
Solved
I'm writing some mathematical code in Python and using Sphinx to produce the documentation. I know that Sphinx can handle LaTeX code in Python docstrings; see https://www.sphinx-doc.org/en/master/u...
Trematode asked 15/3, 2012 at 21:16
7
If I do sphinx-quickstart I get asked about the version of the project.
I want to avoid to have two places for the version of my project.
How to do this in the python packing world?
Risley asked 1/10, 2014 at 12:53
1 Next >
© 2022 - 2024 — McMap. All rights reserved.