有没有办法在rst有自动标题编号？这就是:
#. Some Section
===============
...
#. Some Subsection
------------------
...
#. Another Subsection
---------------------
...
#. Another Section
==================
...
将呈现为:
...
...
...
...
我一直在使用Sphinx和reStructuredText记录软件包.
在我的文档中,有一些很长的代码片段.我希望能够将它们隐藏为默认值,并使用一个"显示/隐藏"按钮来扩展它们(示例).
有没有一种标准的方法可以做到这一点？
有没有办法在sphinx中设置单个单词(或字符)的颜色？我很确定应该有一些标记标记,比如HTML font标记.
我尝试在reStructuredText中插入粗体文本的链接但是失败了.
这是我的第一个来源:
**Lorem ipsum dolor sit amet, `consectetur <http://www.example.com>`_
adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.**
但我得到了:
<strong>Lorem ipsum dolor sit amet, `consectetur <http://www.example.com>`_
adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.</strong>
我想得到这个:
<strong>Lorem ipsum dolor sit amet, <a href="http://www.example.com">consectetur</a>
adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.</strong>
有没有办法在表格单元格中输入换行符？例如,假设我有一个这样的表:
+----------+----------+----------+
| Header 1 | Header 2 | Header 3 |
+==========+==========+==========+
| Item 1 | | |
| Item 2 | | |
+----------+----------+----------+
我希望上面创建一个包含两行,三列和第二行的表,第一列在单独的行上显示Item 1和Item 2.
我已经尝试了行块语法|,但它在表格单元格中不起作用.我可以使用列表语法,但我不希望出现项目符号.
如何将python doc字符串转码为Github readme.md？
虽然看起来似乎每个人都做了,我似乎无法得到一个像样的解决方案,我认为它应该很容易,所以似乎人们不太可能抛出两个转换器......
pydoc 其实很简单.pydoc的输出是联机帮助页(UNIX系统的groff格式).这是一个死胡同,因为男人对md不是一件事.通过HTML,pydoc3 -w+ pandoc,完全将文档字符串转换为位.
自定义代码似乎有很多简短的自定义代码,但对于少数我尝试过的输出似乎不如pydoc那样好,它有一个摘要,添加了继承的方法并列出了一些属性.
mkdocs.有人建议在某处.它只会污染我的文件夹,因为它是一个误导性的名称,因为它不是docstrings> md转换器,而是md> html.
狮身人面像+潘多克.在解决了UTF-8问题之后,我放弃了Sphinx,因为我有一个要转换的py脚本,并且快速启动的autodoc设置没有解析我的脚本.我尝试用Python导入sphinx.ext.autodoc但TBH的文档太长了,我放弃了.
有一个[一年前未解答的SO问题](从Python Docstrings自动生成GitHub Wiki文档)关于这个主题,但我希望通过提供更多细节我会得到答案.
在eclipse下是否有针对reStructuredText的WiKiText编辑器插件？当我编辑.textile文件时,我会获得各种智能编辑功能(例如折线)和预览面板.我发现在各种MyLyn包下都有对reStructuredText的引用,但是在安装它们之后我仍然找不到reStructuredText编辑器.是因为没有一个吗？
谢谢.肯特
我正在使用Sphinx为我正在开发的Python项目创建文档.我有三张图片,我想在一个1×3格(即所有在同一行)来显示,而我试图找出如何在新结构化做到这一点.现在我有
.. image:: _images/report_title.png
.. image:: _images/report_slide1.png
.. image:: _images/report_slide2.png
我想在一条线上试图围绕它们构建一个reST表,但这看起来有点荒谬.我如何对这些图像进行网格化？
从文档中可以看出,双引号用于文字,而单引号则在有代码文本被解释时使用.
这将导致我为f()下面的方法编写docstring :
class A(B):
def f(arg1, arg2):
return B(arg1 + arg2 + self.index)
如:
Takes two arguments, ``arg1` and ``arg2``, which are assumed to be objects
of type (or duck-type) `NiceClass`, and returns a new object of class `B`
with `B.something` assigned some hash of ``arg1`` and ``arg2``.
这是正确的吗？
在许多代码示例中,Sphinx和其他方面,我看到相当于B并NiceClass用双引号括起来("``B``"和"``NiceClass``").
我想将我的项目包含README.md在我的Sphinx文档中,例如
Can sphinx链接到不在根文档下面的目录中的文档？
- 在生成的Sphinx html文档中,我点击欢迎页面上的目录中的链接,然后转到README.md.
为此,readme_link.rst创建了包含行的文档
Readme File
-----------
.. include:: ../../README.md
我添加了这一行
README <readme_link>
进入toctree index.rst.与此同时,我README.md不会被解析为Markdown,而只是按原样打印到页面上.
我认为另一个想法可能是改为使用markdown文件readme_link.md,但是没有办法包含markdown文件.
如何将我的README.md解析为markdown？
(当然我不想把它重写为.rst.)
我试图从.rst文件中的markdown文件中跟随Render输出,但这不起作用.我README.md有一些标题
# First heading
some text
## Second heading 1
some text
## Second heading 2
some text
我得到了错误WARNING: ../README.md:48: (SEVERE/4) Title level inconsistent:.我理解"标题级别不一致"是什么意思？我需要使用其他符号 - 但读入它们我意识到答案是指rst符号.这意味着我的降价自述文件实际上并未转化为rst.
PS:尝试类似这样的人的其他人是 https://muffinresearch.co.uk/selectively-including-parts-readme-rst-in-your-docs/