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 有人有這方面的一些經驗?也許更好的主意?該函數已經在獅身人面像中捆