python-sphinx

    6热度

    1回答

    我们在SVN中使用Sphinx维护了一个相当大的文档。 作为生成输出的一部分,我们希望将相关Python模块的发行说明作为主要内容(而不是超链接!)。 SVN中还维护了外部模块的发行说明。是否有一些Sphinx-ish的方式来从其他(SVN)源文件的部分拉动?好的,使用SVN外部是一种解决问题的方法,但可能不是最聪明的方式......任何更好的选择?

    8热度

    2回答

    我想用狮身人面像来记录一个项目,但我不知道如何使用 intersphinx。我使用这一行: :py:meth:`math.sin` 添加链接,但在输出中,它显示为粗体而不是链接。 虽然该行不行,下面的两个操作: :py:meth:`dict.items` :py:class:`zipfile.ZipFile` 我在conf.py文件intersphinx_mapping值: inters

    2热度

    3回答

    我在Python 3中编写了一个程序,并且正在使用Sphinx来记录它。 Sphinx的autodoc很棒,但它只适用于Python 2.一些模块在autodoc中工作正常,但是模块不能。一些示例:Python 2抱怨Python 3风格的元类,以及Python 2中不再存在的某些模块,如configparser。这很烦人,因为它无法从该文件导入文档。 我不想在Python 2中重写整个程序,但是

    6热度

    1回答

    我习惯于使用Sphinx来处理C++和Python项目。我刚刚在Clojure开始了一个项目,我想重新使用我的Sphinx/reStructuredText技能来记录我的Clojure代码。由于Clojure没有内置的domain,我开始写一个。具有讽刺意味的是,Sphinx的文档对写作扩展没有任何帮助。所以,从Python和Javascript的内置模式开始,我已经有了一些基本元素的工作。我可以

    2热度

    1回答

    我想在我的狮身人面像文件中包含一个代码示例。 但是,我不想通过其路径 来引用该文件,但宁可用其模块名称来指定它。 也就是说,是不是做 .. includemodule mymodule.example 在此间表示Showing code examples .. literalinclude example.py 或 .. literalinclude ../../example.py

    3热度

    1回答

    我已经调查,并有,狮身人面像寄予厚望。 但是,它不会做一个文档框架我想要的一切。下面是我在寻找: 维基样(即网络编辑)环境版本跟踪 的车博士的支持(即文档字符串的进口等) (理想)一个用于版本管理的连接器,以便代码可以从早期版本中浏览 有没有这样的东西存在?

    7热度

    1回答

    我输出documentation作为pdf使用Sphinx。除了输出python源代码之外,这一切都很好,然后单引号(unicode U + 0027)被输出为右单引号(U + 2019),这看起来很尴尬。 Here是有问题字形的图像,here是我生成的pdf。 有人知道如何解决这个问题吗?

    3热度

    3回答

    是否有某种方法可以使用Sphinx 1.0.7直接从Sphinx项目生成S5演示文稿? 我在Sphinx中发现了多个对内置S5构建器的引用,但是除了docutils中的相关代码外没有发现任何有用的东西。 任何提示?

    2热度

    2回答

    在狮身人面像中,是否可以自动定义标题标签?我发现我的文档最终看起来很像这样: .._doing stuff: Doing Stuff ----------- You might also want :ref:`other stuff`. .._other stuff: Other Stuff ----------- No, you want :ref:`doing st

    1热度

    1回答

    通常,与狮身人面像相关的最佳实践表示,您必须将行长度限制为少于80个字符。 所以我想要一种方法来自动限制我的行长度少于80个字符(没有连字符),当纠正发生时,它必须把正确的缩进(如果可能的话)。 我见过的唯一功能似乎适合一点是Textwrap http://docs.python.org/library/textwrap.html 有人有这方面的一些经验?也许更好的主意?该函数已经在狮身人面像中捆