我正在試驗Sphinx和ReadTheDocs(RTD),以便在每次GitHub推送時編譯我的文檔。不幸的是,RTD發現包含conf.py
文件的多個文件夾doc
/docs
。我的repository使用git子模塊嵌入第三方庫。其中一些也使用Sphinx記錄。我認爲最大的(持久文檔構建)贏得並覆蓋最終RTD視圖中的所有靜態HTML頁面。RTD編譯我的所有文檔,包括來自git子模塊的外來文檔
我怎樣才能排除或告訴RTD忽略這些子模塊的文件夾:
lib/cocotb
lib/osvvm
lib/vunit
docs/source/_themes/sphinx_rtd_theme
我的文檔位於:
docs/source/conf.py
docs/source/index.rst
據我發現,RTD不支持*.yml
文件,但沒有條目來定義文檔根文件夾。
任何想法來解決我的問題?
當我在本地編譯我的文檔時,不包括這些文件夾。從搜索中排除'* .rst'或其他源文件不會阻止RTD在整個存儲庫中找到多個'conf.py'文件。 'conf.py'文件位於'docs/source'中。所以這些lib目錄超出了範圍。 – Paebbels
您可以嘗試在'exclude_patterns'中指定'conf.py'的所有相對路徑,以查看在構建時是否還包含這些文件 – zack