我正在尝试使用Sphinx来记录项目,但我无法弄清楚如何使用intersphinx.我用这行:
:py:meth:`math.sin`
Run Code Online (Sandbox Code Playgroud)
添加链接,但在输出中,它显示为粗体,而不是链接.虽然该行不起作用,但以下两者都有效:
:py:meth:`dict.items`
:py:class:`zipfile.ZipFile`
Run Code Online (Sandbox Code Playgroud)
我在conf.py文件中的intersphinx_mapping值是:
intersphinx_mapping = {'python':('http://docs.python.org/2.7', None)}
Run Code Online (Sandbox Code Playgroud) 我正在使用Sphinx编写一个包含大量引用的文档:
.. _human-factor:
The Human Factor
================
...
(see :ref:`human-factor` for details)
Run Code Online (Sandbox Code Playgroud)
编译后的文档包含以下内容:
(详见人体因素)
相反,我希望它的格式如下:
(详见5.1人为因素)
我试图谷歌解决方案,我发现乳胶hyperref包可以做到这一点,但我不知道如何将其添加到Sphinx构建.
有这样的功能:
def foo(x: int) -> float:
return float(x)
Run Code Online (Sandbox Code Playgroud)
我想使用类似NumPy的文档字符串,如下所示:
def foo(x: int) -> float:
"""
Parameters
----------
x
Input parameter
Returns
-------
The output value.
"""
return float(x)
Run Code Online (Sandbox Code Playgroud)
注意:
是否有支持它的Sphinx扩展?你会推荐另一种语法吗?
我想为CMU Sphinx建立一个语言模型,但我的语料库有超过1000个单词,所以我不能使用在线工具.我如何使用(cmuclmtk中的脚本?)来构建我的语言模型?
我有一个Python项目,它有Sphinx文档和distutils用于发布到Pip.
这两个功能都需要一个版本(例如,0.4b3)
是否有最佳实践可以在需要版本号的各种实用程序中自动维护一致的版本号?
作为奖励,是否有任何与git集成的东西(例如,通过标签)?
Python官方网站提供PDF文档下载,但它们由章节分隔.我下载了源代码并构建了PDF文档,这些文档也是单独的PDF文件.
如何从源代码中的Makefile构建一个PDF文件?我认为阅读会更方便.
如果连接单独的PDF不会遗漏目录(书签),那也是可以接受的.我试图convert从ImageMagick的,pdftk和pdfunite从poppler-utils,它们都连接后失去的书签.
我希望sphinx生成类似于doxygen生成的模块概述,这是一个例子
我无法找到狮身人面像如何做到这一点
我可以使用Graphviz生成某种图形,但是我找不到一种方法来获取图形中的可点击对象,其操作方式与上面的示例相同.
是否有任何方法可以直接在sphinx中执行此操作,或者使用某些hack使其作为doxygen模块概述工作?
我尝试使用 lxml 解析文件,iterparse因为实际文件会很大。我有以下代码:
import xml.etree.cElementTree as etree
filename = r'D:\test\Books.xml'
context = iter(etree.iterparse(filename, events=('start', 'end')))
_, root = next(context)
for event, elem in context:
if event == 'start' and elem.tag == '{http://www.book.org/Book-19200/biblography}Book':
print(etree.dump(elem))
root.clear()
Run Code Online (Sandbox Code Playgroud)
我的 XML 看起来像这样:
<Books>
<Book xmlns="http://www.book.org/Book-19200/biblography"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
ISBN="519292296"
xsi:schemaLocation="http://www.book.org/Book-19200/biblography ../../book.xsd
http://www.w3.org/2000/12/xmldsig# ../../xmldsig-core-schema.xsd">
<Detail ID="67">
<BookName>Code Complete 2</BookName>
<Author>Steve McConnell</Author>
<Pages>960</Pages>
<ISBN>0735619670</ISBN>
<BookName>Application Architecture Guide 2</BookName>
<Author>Microsoft Team</Author>
<Pages>496</Pages>
<ISBN>073562710X</ISBN>
</Detail>
</Book>
<Book xmlns="http://www.book.org/Book-19200/biblography"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
ISBN="519292296"
xsi:schemaLocation="http://www.book.org/Book-19200/biblography ../../book.xsd
http://www.w3.org/2000/12/xmldsig# ../../xmldsig-core-schema.xsd">
<Detail ID="87">
<BookName>Rocking Python</BookName>
<Author>Guido …Run Code Online (Sandbox Code Playgroud) 我有以下文件结构......
> Boo
> ---modA
> ------__init__.py
> ------fileAA.py
> ---modB
> ------__init__.py
> ------fileBB.py
Run Code Online (Sandbox Code Playgroud)
当我在fileBB.py里面时
from modA.fileAA import <something>
Run Code Online (Sandbox Code Playgroud)
我收到以下错误:
from modA.fileAA import <something>
ModuleNotFoundError: No module named 'modA'
Run Code Online (Sandbox Code Playgroud)
请注意,__init__.py文件为空并使用Python 3.
我在这里错过了什么或做错了什么?
我在源代码中有以下格式的 Sphinx 文本:
Line 1 Line 2 Line 3 Line 4
Run Code Online (Sandbox Code Playgroud)
我希望第 4 行在单独的物理行上以 HTML 呈现。这可能吗?
python ×7
python-3.x ×2
cmusphinx ×1
distutils ×1
elementtree ×1
graph ×1
importerror ×1
latex ×1
project ×1
version ×1
xml ×1