restructuredtext

问题 I've gotten lost in an edge case of sorts. I'm working on a conversion of some old plaintext documentation to reST/Sphinx format, with the intent of outputting to a few formats (including HTML and text) from there. Some of the documented functions are for dealing with bitstrings, and a common case within these is a sentence like the following: Starting character is the blank " " which has the value 0. I tried writing this as an inline literal the following ways: Starting character is the

问题 I'm using the wonderful Sphinx tool to create some documentation and I'm trying to keep the codebase in a modular form by separating chapters of the same part into separate files. (See here for definitions of 'chapter' and 'part'.) I've tried to do this using two files, test1.rst : ###### Part 1 ###### ********* Chapter 1 ********* Section 1 ========= Test Content 1. and test2.rst : ********* Chapter 2 ********* Section 2 ========= Test Content 2. They are included in index.rst like this: ..

问题 I generate a documentation from rst to pdf with latexpdf and sphinx. How can I remove chapter title before every chapter? ----------- CHAPTER ONE ----------- 回答1: As noted in the sphinx documentation you can change the latex_documents documentclass to a howto documentclass, which will get rid of the "Chaper" before your section. However, this will also change formatting slightly for the whole build. documentclass: Normally, one of 'manual' or 'howto' (provided by Sphinx). Other document

问题 I have the following index.rst file. Know the cell population of your data ===================================== Some content .. toctree:: :maxdepth: 2 Installation ~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 installation Scripts ~~~~~~~ .. toctree:: :maxdepth: 2 scripts API documentation ~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 apidoc Roadmap ~~~~~~~ .. toctree:: :maxdepth: 2 roadmap Indices and Tables ================== * :ref: `genindex` Now the sidebar looks like this: As described in that

问题 I am trying to embed a LaTeX variable into some reStructuredText. I know about the ".. raw::" directive, but I want this to be embedded in a paragraph of text. Specifically, I am looking to replicate the \numquestions\ and \numpoints\ variables from the template exam document. I have tried using :raw: \numquestions\ , but this does not seem to be valid. Is there any way of doing this? 回答1: You first have to define your own latex role, which allows you then to embed LaTex directly into

问题 As is asked and answered in this post, one can use SyntaxHighlighter for pretty code listing. With ReStructuredText, I can use raw directive as follows. .. raw:: html <script type="text/javascript" src="http://alexgorbatchev.com/pub/sh/current/scripts/shCore.js"></script> <script type="text/javascript" src="http://alexgorbatchev.com/pub/sh/current/scripts/shBrushJScript.js"></script> <link type="text/css" rel="stylesheet" href="http://alexgorbatchev.com/pub/sh/current/styles/shCoreDefault.css

问题 How I can use rst in nodes? For example I want to output icluded file about.rst class Foo(Directive): def run(self): return [ nodes.Text("**adad**"), # <-- Must be a bold text nodes.Text(".. include:: about.rst"), # <-- Must include file ] 回答1: You can construct a ViewList of your raw rst data (one line per entry), get Sphinx to parse that content, and then return the nodes Sphinx gives you. The following worked for me: from docutils import nodes from docutils.statemachine import ViewList

问题 I often have the situation that I want to link a term to the glossary but state the term in plural. So normally you do something like this in singular: Some text before the term :term:`important word` then the stuff after the term This is considered a completely different term: Some text before the term :term:`important words` then the stuff after the term This doesn't get parsed: Some text before the term :term:`important word`s then the stuff after the term And this is very redundant (but

问题 My hand-written documentation/user-guide (written in ReStructuredText with sphinx) has become quite big so I started organize my .rst-files in sub-directories. In the index.rst I'm including a subindex.rst of each sub-directory which itselfs includes other .rst -files for further sub-directories. index.rst : .. include:: subdir1/subindex.rst .. include:: subdir2/subindex.rst subdir1/subindex.rst : .. include:: file1.rst .. include:: file2.rst In principle this works well, except that sphinx

问题 I have a Python project that is hosted on both Github and PyPI. On Github: https://github.com/sloria/TextBlob/blob/master/README.rst On PyPi: https://pypi.python.org/pypi/textblob My README.rst doesn't seem to be formatting correctly on PyPI, but it looks fine on Github. I have already read this, but I don't have any in-page links, so that's not the problem. 回答1: You are using a newer text role, :code:. PyPI appears to only support docutils 0.8, with code and code-block added to the PyPI