python-sphinx

    0热度

    1回答

    我triyng用狮身人面像来记录我的django项目,但我遇到了一些麻烦。 当我运行make html命令我得到这个错误: /home/santoryu/richiestaTesi/docs/models/models.rst:3: WARNING: autodoc: failed to import module u'myapp.models'; the following exception

    2热度

    1回答

    作为一个简单示例,在以下2个子模块(相同目录中的a.py和b.py)的代码中。到相同子模块功能:func:`hook`的链接工作,但不链接到不同模块的交叉引用,即:func:`foo`。我也尝试了:func:`.a.foo`的语法 - 仍然不起作用。我怎样才能交叉参考a.foo()? # script a.py def foo(): '''foo func''' # script

    0热度

    1回答

    我正在使用Sphinx生成我的应用程序的文档,使用QtHelpEngine进行查看。因此我使用qthelp构建器。 我不明白如何从用作源的reStructuredText正确创建qhp文件的关键字部分。 Sphinx默认创建一个空的标签: <keywords> </keywords> ,然后linksForIdentifier()和linksForKeyword()返回一个空QMap。

    0热度

    1回答

    我被pythons卡住sphinx。我的目录树是这个样子: | - project_root | | - importable_project | | | - importable_module.py | | | - another_importable_module.py | | | - Tutorials | | | | - tutorial1.ipynb | | - docs

    1热度

    1回答

    我正在浏览sphinx的Templating页面上列出的各种变量。但我无法获取当前html的路径(在模板(_template/layout.html)内)。 最近我得到的是使用rellinks。问题是它提供了next和previous页面的路径,但不是当前页面。 同样, {{ file }}给./.html {{ pathto(pagename) }}给./build/html 我想一个HTML文

    1热度

    1回答

    我在寻找语法/扩展到包括通过快捷方式类似于一个在狮身人面像文档页面的右下角语言,版本和格式链接: Sphinx Documentation Version/ Language/ Formats links 它是一个reStructuredText指令或生成这些链接持有者的Sphinx扩展吗?

    1热度

    1回答

    我正在使用美妙的狮身人面像工具来创建一些文档,我试图通过将相同部分的章节分隔成单独的文件来保持代码库处于模块化的形式。 (See here for definitions of 'chapter' and 'part'.) 我试图做到这一点使用两个文件,test1.rst: ###### Part 1 ###### ********* Chapter 1 ********* Sec

    1热度

    1回答

    我已经了解到,可以通过多个文件by using the include command将部分/章节等文档保存为模块形式。 这种方法唯一的问题是,它有效地将所有包含的文件连接成一个大文件,这意味着它们不再被Sphinx Read The Docs theme视为单独的页面。 由于这一结果,文档有用户需要向下滚动,而不是previous/next按钮导航短的网页很长页面。我希望我的文档具有后一种结构,

    1热度

    1回答

    如何将狮身人面像生成的乳胶代码集成到现有的乳胶文档中? 我的问题与here相同,但我在6年后认为应该找到解决此问题的方法。如果没有,现在有一些步骤可以手动进行?最佳实践?

    1热度

    1回答

    我继续使用ReadTheDocs使用带有使用sphinx和readthedocs主题呈现的Jupyter笔记本的github存储库构建失败。我能够在本地渲染这些,但是当我尝试用RTD,我得到以下失败消息: 我试着放置nbsphinx.py服务器中的资源,但事情仍然会失败。链接到RTD是在这里: https://readthedocs.org/projects/calculus-notes/ Git