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