sphinx python 使用及國際化設定

2021-08-07 01:46:43 字數 1142 閱讀 2137

我寫了乙個sphinx python 生成文件的demo,包括國際化。

git位址

專案中的引數都是我已經配置好的,source/_static是專案的靜態檔案目錄包括css,js,img

我在專案中引入了default.css 和 default.js兩個檔案作為預設的樣式和指令碼檔案。

所以如果大家對編譯之後的頁面不滿意,想要自己調一下的話在這兩個檔案中操作即可。

關於國際化,sphinx-intl只提供了文字的國際化,並沒有引用的國際化(也可能是我沒有找到解決方法,如果有大神知道,歡迎來賜教一番)。所以我在引入的default.js檔案中對引用的進行了處理,通過判斷url來判斷應該引入哪種語言的所以只需要放入對應的資料夾就可以,必須保證各種語言的名稱一致。

下面是具體的安裝及使用方法.

例如:pip install -i sphinx,

這樣就會從清華這邊的映象去安裝 sphinx 庫, 親測速度槓槓的.

官方文件中提到的一些配置我在實際操作中發現有些不起作用 比如 這段:

add any paths that contain custom static files (such as style sheets) here,

relative to this directory. they are copied after the builtin static files,

so a file named "default.css" will overwrite the builtin "default.css".

html_static_path = ['_static']

說是在_static中放乙個default.css檔案就會覆蓋掉原始的樣式,但我發現,如果我們引用的不是預設主題,那麼頁面中是不會引用de****t.css的 所以不起作用,可以用下面的配置替換這個方法

在conf.py中寫入這段**,意思是將我們的default.css 和de****t.js 寫入編譯好的html頁面中

不要用editplus,這是我踩的乙個坑,因為存在乙個編碼問題,python編譯時候會報錯,

玩過python的應該都能解決,解決不了那就換乙個編輯器吧 比如 vscode

Sphinx python模組自動生成文件

安裝 pip install sphinx假設現在我們有乙個叫run.py的檔案,如下 run.py defrun name this is how we run param name name of people who runs print name,is running toctree max...

建立及使用

你好!這是你第一次使用markdown編輯器所展示的歡迎頁。如果你想學習如何使用markdown編輯器,可以仔細閱讀這篇文章,了解一下markdown的基本語法知識。全新的介面設計,將會帶來全新的寫作體驗 在創作中心設定你喜愛的 高亮樣式,markdown將 片顯示選擇的高亮樣式進行展示 全新的ka...

awk 使用高階及使用案例

chen localhost in shell 18 36 13 awk v num 3 f passwd33 3333 注意 awk中呼叫定義的變數不需要加 chen localhost in shell 18 37 04 awk v num 3 f passwd01 23561.3.1.概述 1...