我可以在“閱讀文檔”中構建和托管自定義HTML頁面嗎？
[英]Can I build and host custom HTML pages at Read the Docs?
問題描述
我程序的文檔主要是用Sphinx編寫的，但是它還包括兩個自定義HTML頁面：
這兩個HTML文件是由程序本身而不是Sphinx生成的。
我想將我的文檔托管在Read the Docs上 ，這對我來說非常方便，可以與Sphinx文檔一起構建和托管版本化的兩個自定義頁面。
由於啟用了“ 安裝項目”選項，因此我的程序已經安裝在RtD構建環境中。 而且由於RtD文檔提到編寫您自己的構建器 ，所以我認為可以從那里調用我的程序並將它的HTML內容轉儲到特定位置。
所以我真的有兩個問題：
這是否適合使用“閱讀文檔”？ 我猜它不是設計來承載任意網頁的，但是同樣，那些文件也不是任意的，它們是文檔的重要組成部分。
我將如何實施？ 我很難理解RtD API ：這個“構建器”與Sphinx構建器有任何關系嗎？ 如何將其連接到RtD？ 也許某處有一個例子？
1 個解決方案
解決方案1
0 已采納 2017-08-02 17:08:38
我使用Sphinx的html_extra_path功能獲得了預期的結果：
包含多余文件的路徑列表，這些文件已復制到輸出目錄。
為了生成這些文件，我沒有在conf.py找到比正確的地方更好的地方了，這似乎有點conf.py可危，但到目前為止已經可以使用了。 當然，需要在“閱讀文檔”高級設置中啟用在virtualenv中安裝項目 。
現在，我的自定義notices.html和showcase.html就像Sphinx本身生成的.html頁面一樣，具有版本控制和重定向： http : //httpolice.readthedocs.io/page/notices.html
如何設置“閱讀文檔”以便 Sphinx 自動文檔選項起作用？
[英]How can I set up Read the Docs so the Sphinx autodoc option works?
是否可以使用 read-the-docs 在構建時生成圖像和 .rst 文件？
[英]Is it possible to generate images and .rst files on build with read-the-docs?
在使用 fastapi 作為超級令牌的后端時，如何訪問 /docs 或自定義路由端點？
[英]How can I access the /docs or custom routes end point while using fastapi as backend for supertokens?
如何使lxml將兩個頁面保存到頁面中，以便樹可以讀取它？
[英]How can I make lxml save two pages to the pages so it can be read by the tree?
聲明:本站的技術帖子網頁，遵循CC BY-SA 4.0協議，如果您需要轉載，請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.
相關問題
閱讀文檔構建失敗的UnicodeDecodeError
閱讀文檔生成由於提示而失敗
閱讀Docs構建失敗而沒有錯誤嗎？
Read the Docs Sphinx build 中不包含文檔字符串
為什么我的“閱讀文檔”構建失敗？
如何設置“閱讀文檔”以便 Sphinx 自動文檔選項起作用？
是否可以使用 read-the-docs 在構建時生成圖像和 .rst 文件？
在使用 fastapi 作為超級令牌的后端時，如何訪問 /docs 或自定義路由端點？
如何使lxml將兩個頁面保存到頁面中，以便樹可以讀取它？
我在 Django 中看不到我的 404 和 500 自定義頁面
相關標簽