python-sphinx

Can't get sphinx to link under toctree to another document

我与影子孤独终老i 提交于 2020-08-27 04:13:12
问题 I'm attempting to learn sphinx and am stuck on just the basic examples. I'm being given the following error on a make html in the source directory. Running Sphinx v1.1.3 loading pickled environment... not yet created building [html]: targets for 2 source files that are out of date updating environment: 2 added, 0 changed, 0 removed reading sources... [100%] intro /home/owner/Desktop/doc/index.rst:11: ERROR: Error in "toctree" directive: invalid option block. .. toctree:: :maxdepth: 2 intro

Preformatted (verbatim) hyperlink in Sphinx-reST-RTD

社会主义新天地 提交于 2020-08-24 03:43:30
问题 I am building documentation with Sphinx-RTD. I want to have a link somewhere, and be styled as a verbatim or preformatted text. For example, say I have this verbatim: ALTER TABLE Is there a way to link it somewhere, say a :ref: ... or even just a standard hyperlink? 回答1: If I am not mistaken the "Replacement Text" directive can help. As reStructuredText doesn't support nested inline markup, the only way to create a reference with styled text is to use substitutions with the "replace"

Preformatted (verbatim) hyperlink in Sphinx-reST-RTD

ぃ、小莉子 提交于 2020-08-24 03:40:27
问题 I am building documentation with Sphinx-RTD. I want to have a link somewhere, and be styled as a verbatim or preformatted text. For example, say I have this verbatim: ALTER TABLE Is there a way to link it somewhere, say a :ref: ... or even just a standard hyperlink? 回答1: If I am not mistaken the "Replacement Text" directive can help. As reStructuredText doesn't support nested inline markup, the only way to create a reference with styled text is to use substitutions with the "replace"

Preformatted (verbatim) hyperlink in Sphinx-reST-RTD

对着背影说爱祢 提交于 2020-08-24 03:40:12
问题 I am building documentation with Sphinx-RTD. I want to have a link somewhere, and be styled as a verbatim or preformatted text. For example, say I have this verbatim: ALTER TABLE Is there a way to link it somewhere, say a :ref: ... or even just a standard hyperlink? 回答1: If I am not mistaken the "Replacement Text" directive can help. As reStructuredText doesn't support nested inline markup, the only way to create a reference with styled text is to use substitutions with the "replace"

How to include image files in Sphinx + Latex Pdf files

风流意气都作罢 提交于 2020-08-20 12:07:39
问题 I am using Sphinx Documentation tool alongwith LaTeX to generate pdf files. While trying to include images in the pdf file, I am coming up with the following error during compile: LaTeX Warning: File `{img_file}.jpg' not found on input line 920. ! Package pdftex.def Error: File `"""{img_file}".jpg' not found: using dra ft setting. See the pdftex.def package documentation for explanation. Type H <return> for immediate help. ... l.920 ...phinxincludegraphics{{img_file}.jpg} } ? These are some

How to ensure that all Indices are corrected generated in Sphinx Documentation

半腔热情 提交于 2020-08-20 06:18:11
问题 I am creating documentation using Sphinx for my Django app. To aid / reinforce information in the documentation, I have added my own source files ( .rst ) placed both in the root folder /docs/ and another folder /docs/modules/ like this: docs/ abc.rst <folders1, 2 ...> modules/ about.rst extra_folder/ xyz.rst quest.rst ...... Now I generated the docs using make html at the terminal and the docs are created which I am able to view in the browser. I can see the links to my .rst files on the

How to ensure that all Indices are corrected generated in Sphinx Documentation

空扰寡人 提交于 2020-08-20 06:18:05
问题 I am creating documentation using Sphinx for my Django app. To aid / reinforce information in the documentation, I have added my own source files ( .rst ) placed both in the root folder /docs/ and another folder /docs/modules/ like this: docs/ abc.rst <folders1, 2 ...> modules/ about.rst extra_folder/ xyz.rst quest.rst ...... Now I generated the docs using make html at the terminal and the docs are created which I am able to view in the browser. I can see the links to my .rst files on the