标签: python-sphinx

你怎么能在底部解决狮身人面像的警告？

我想在Sphinx中获取我的Python笔记.我将我的笔记放在与index.rst相同的目录级别的单独文件中.

构建HTML后,我收到以下警告

警告

/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree

在

构建时的完整信息

sudo sphinx-build -b html ./ _build/html
Running Sphinx v0.6.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 1 added, 2 changed, 0 removed
reading sources... [100%] trig_functions
/home/heo/S_codes/databooklet.rst:1: (WARNING/2) malformed hyperlink target.
/home/heo/S_codes/index.rst:11: (ERROR/3) Error in "toctree" directive:
invalid option block.

.. toctree::
   :numbered:
   :glob:
   *
   databooklet.rst
   trig_functions.rst


/home/heo/S_codes/trig_functions.rst:11: (ERROR/3) Unexpected indentation.
looking for …

是否有可能在sphinx文档生成器中使文本删除？

我有一个这样的课:

class MyBase(object):
   x = 3
   """Documentation for property x"""

和另一个继承它的类:

class MyObj(MyBase):
   x = 0

当我使用sphinx的autodoc生成文档时,MyObj.x没有记录.有没有办法从中继承docstring MyBase.x？我找到了DocInherit,但由于它使用了一个装饰器,它只适用于类方法.有什么方法可以用属性做到这一点？

我在Python 3中编写了一个程序,并使用Sphinx来记录它.Sphinx的autodoc很棒,但它只适用于Python 2.有些模块在autodoc中工作正常,但模块却没有.一些例子:Python 2抱怨Python 3样式元类,以及一些在Python 2中不再存在的模块,如configparser.这很烦人,因为它无法从该文件导入文档字符串.

我不想在Python 2中重写整个程序,但我想使用autodoc.

我有一个想法是一个小程序,它读取每个Python文件并删除所有功能,但只是将基本函数和类与其文档字符串一起离开(因为autodoc导入每个模块并读取特定函数或类的文档字符串).

import configparser
import os

class TestClass:
    """
    I am a class docstring.
    """
    def method(self, argument):
        """
        I am a method docstring.
        """
        #Some code here
        print(os.getcwd())

def TestFunction():
    """
    I am a function docstring.
    """
    #Some more useless code here
    return os.path.join("foo", "bar")

成...

class TestClass:
    """
    I am a class docstring.
    """
    def method(self, argument):
        """
        I am a method docstring.
        """
        pass

def TestFunction():
    """
    I …

我已经在virtualenv中安装了CKAN并激活了virtualenv,并且我已经在pip-requirements-docs.txt中安装了这些需求,但是当我尝试构建文档时,我收到此错误:

> python setup.py build_sphinx
...
sphinx.errors.ThemeError: no theme named 'sphinx-theme-okfn' found (missing theme.conf?)

我有一个很好的有关项目的狮身人面像文档，我想扩展它以生成诸如规范等文档。我希望有spec-for-foo.rst产生spec-for-foo.pdf

我试图在我的 reST 简单表中放置一个项目符号列表，但项目符号列表的每一行都有自己的行：

======================  =======================  =======================
|foo.png|               |bar.png|                |baz.png|
======================  =======================  =======================
* foo1 - Lorem ipsum    * bar                    * baz 
  dolor sit amet, 
  consectetur 
* foo2 - adipisicing 
  elit
======================  =======================  =======================

.. |foo.png| image:: assets/img/foo.png
.. |bar.png| image:: assets/img/bar.png
.. |baz.png| image:: assets/img/baz.png

其结果是，每行的* foo1 - Lorem ipsum，dolor sit amet,，consectetur，* foo2 - adipisicing和elit被放置到单独的表行。

期望的结果是第一列中的项目符号列表包含在一个表行项目中。有没有一种简单的方法可以获得我想要的结果？

如果做不到这一点，有没有办法将我的设计的 HTML 表格嵌入到 reST 文档中？

我尝试过的另一件事是替换：

======================  =======================  =======================
|foo.png|               |bar.png|                |baz.png|
======================  ======================= …

我正在尝试在远程计算机上安装狮身人面像。

由于我无权访问根目录，因此我这样做：

$bash

$mkdir -p ~/local/lib/python2.7/site-packages

$export PYTHONPATH=$PYTHONPATH:~/local/lib/python2.7/site-packages

$export PATH=$PATH::~/local/lib/python2.7/site-packages

$easy_install -U --prefix=$HOME/local Sphinx

但显然，$easy_install它不会建立sphinx-quickstart。当我打字

$sphinx-quickstart

我收到以下消息：

bash: sphinx-quickstart: command not found

我试过了

find $HOME -name sphinx-quickstart 

没有找到结果。但是，我可以在python中导入sphinx：

$python

然后

>>import sphinx 

作品。知道为什么sphinx-quickstart不起作用吗？

我有一个相当复杂的项目,有相当大的文档.通过Sphinx 将普通用户指南转换为PDF make latexpdf可以很好地工作.但是,如果我还想将库引用包含在所有函数,类和模块文档中,则该命令将失败:

! LaTeX Error: Too deeply nested.

手动减少嵌套不是一种选择.Sphinx内部嵌套参数描述,功能描述,模块描述等等.因此,在每种情况下弄清楚如何减少嵌套几乎是不可能的.

我的index.rst中有一个toctree看起来像这样:

.. toctree::
   :maxdepth: 2

   cat
   dog
   moose

我希望使用'api documentation' 来嵌套我的toctree的内容,类似于这里的内容:

所以最终做出类似的事情:

.. toctree::
   :maxdepth: 2
   :dropdown Animals
     cat
     dog
     moose

但我似乎无法在文档中找到任何可以做到这一点的内容.