restructuredtext

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"