Tag: python sphinx

如何在构buildhtml的时候在virtualenv中查找模块的sphinx？: 我想使用virtualenv而不是我的机器上的本地环境生成HTML文档。我已经进入了virtualenv，但是当我运行make html我得到错误说模块不能被导入 – 我知道错误是由于模块在我的本地环境中不可用。如何指定在search文档时应该使用哪个环境（例如virtualenv）？

保留Sphinx中引用的内联代码: 在狮身人面像，如果我有以下标题声明： .. _somestuff: “this is code“, this is not! ============================== 它呈现如下： this is code ，这不是！这是好的，但是，如果我使用的参考，例如： Have a look at :ref:`somestuff` 它丢失了代码格式并呈现如下：看看这是代码，这不是！代替：看看this is code ，这不是！是否可以保留参考中的代码格式？我该怎么办呢？

如何使用sphinx生成python文档时保留换行符: 我正在使用Sphinx生成一个python项目的文档。输出的html不保留文档string中存在的换行符。例：码 def testMethod(arg1,arg2): """ This is a test method Arguments: arg1: arg1 description arg2: arg2 description Returns: None """ print "I am a test method" 狮身人面像O / P： TestModule.testMethod(arg1, arg2) This is a test method Arguments: arg1: arg1 description arg2: arg2 description Returns: None 任何想法如何解决它？

有没有人用Sphinx来logging一个C ++项目？: Sphinx是Python的一个新的文档工具。它看起来非常好。我想知道的是：如何合适这是为了logging一个C ++项目？是否有任何工具将现有的文档（例如doxygen）转换为Sphinx格式？有在线/可下载的使用Sphinx的C ++项目的例子吗？任何使用狮身人面像的人的提示？

在reStructuredText中的链接中设置文本的格式: 你如何格式化reStructuredText中指定的链接文本？具体来说，我希望从我的第一个生成以下的HTML： <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> 结果应该是这样的： optparse.OptionParser文档其中“optparse.OptionParser”部分是固定宽度的字体。我试过了 “`optparse.OptionParser“ <http://docs.python.org/library/optparse.html>`_ 然而，这给了 <tt class="docutils literal">`optparse.OptionParser</tt> documentation <<a class="reference external" href="http://docs.python.org/library/optparse.html">http://docs.python.org/library/optparse.html</a>>`_ 看起来像这样 “optparse.OptionParser documentation <http://docs.python.org/library/optparse.html>\ _

我应该如何使用Google风格的狮身人面像来logging列表，选项和收益？: 如何使用Sphinx-Napoleon为Google样式文档中的生成器指定列表的types，可选参数和返回types？我试过了 List[type] list of type Optional[type] type, optional 和 Yields: type: 分别; 但是都会产生不令人满意的输出，这与生成的其他文档不一致。例如 Optional[type] 只是给可选[types] 没有任何type链接。我试过每个内置的主题，并有相同的问题。我应该如何用狮身人面像 – 拿破仑的Google风格的文档logging这些元素？

自动生成所有Python包内容的文档: 我正在尝试使用Sphinx为我的代码库自动生成基本文档。然而，我很难指示狮身人面像recursion扫描我的文件。我有一个像下面这样的文件夹结构的Python代码库： <workspace> src mypackage __init__.py subpackageA __init__.py submoduleA1 submoduleA2 subpackageB __init__.py submoduleB1 submoduleB2 我在<workspace>运行了sphinx-quickstart，所以现在我的结构如下所示： <workspace> src mypackage __init__.py subpackageA __init__.py submoduleA1 submoduleA2 subpackageB __init__.py submoduleB1 submoduleB2 index.rst _build _static _templates 我已经阅读了快速入门教程http://sphinx.pocoo.org/tutorial.html ，虽然我仍然试图理解文档，但是它的措辞让我担心Sphinx假设我将手动创build我的代码库中的每个模块/类/function的文档文件。但是，我注意到了“automodule”语句，并且在快速启动期间启用了autodoc，所以我希望能够自动生成大部分文档。我修改我的conf.py添加我的src文件夹到sys.path，然后修改我的index.rst使用automodule。所以现在我的index.rst看起来像： Contents: .. toctree:: :maxdepth: 2 Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. automodule:: alphabuyer […]

sphinx-build失败 – autodoc无法导入/查找模块: 我试图开始与狮身人面像，似乎有无情的问题。命令： docs/sphinx-quickstart 我回答所有的问题，一切正常。命令： docs/ls 一切看起来很正常结果： build Makefile source 命令： sphinx-build -d build/doctrees source build/html 这似乎工作。我能够打开index.html文件，看到我想要的“壳”。当我尝试将我的实际源代码作为source文件夹时遇到问题。命令： sphinx-build -d build/doctrees ../ys_utils build/html 结果： Making output directory… Running Sphinx v1.1.3 loading pickled environment… not yet created No builder selected, using default: html loading intersphinx inventory from http://docs.python.org/objects.inv… building [html]: targets for 1 […]

狮身人面像可以链接到不在根目录下的目录中的文件吗？: 我正在使用Sphinx来logging一个非Python项目。我想在每个子模块中分发./doc文件夹，其中包含submodule_name.rst文件来logging该模块。然后，我想将这些文件吸收到主层次结构中，为整个devise创build一个规范。即： Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src 我试图在主project_spec.rst文档toctree中包含这样的文件： .. toctree:: :numbered: :maxdepth: 2 Module 1 <../../modules/module1/docs/module1> 但是，这个错误信息的结果警告：toctree包含对不存在的文档的引用u'modules / module1 / docs / module1' 以某种方式在文档path中使用../是不可能的？更新：添加conf.py位置