作為一個頭(ku)禿(bi)的開發(fā)者，查閱各種文檔是家常便飯，但由于中國特色在查閱一些文檔時總是加載中。而且有時外場調(diào)試還不一定有網(wǎng)，因而將文檔本地化是相當有必要的。本文介紹了一種將文檔編譯為靜態(tài)網(wǎng)頁并本地查閱的方法。

以Pixhawk飛控相關(guān)文檔為例。APM的官方wiki是用Sphinx進行編譯，支持的格式也比較豐富，編譯為靜態(tài)html后可以方便的查找和跳轉(zhuǎn)。而PX4相關(guān)的文檔主要是用gitbook進行編譯管理，相比與Sphinx增加了多語言的切換，但作為靜態(tài)網(wǎng)頁掛載時無法直接跳轉(zhuǎn)。因而考慮使用Nginx作為web服務(wù)器掛載網(wǎng)頁gitbook類的文檔。

建議以下的步驟都在Linux系統(tǒng)下操作，虛擬機或WSL。Win也可以，但會有這樣那樣的奇怪問題。

1.APM文檔本地化

APM文檔的官方repo為https://github.com/ArduPilot/ardupilot_wiki，下載完成后搭建文檔的編譯環(huán)境，官方說明在這里。大體是安裝了sphinx的1.8.3版本然后裝了一些插件，官方提供了Docker和Vagrant的相關(guān)腳本。WSL或者虛擬機運行Sphinxsetup.sh，等待環(huán)境設(shè)置完成后在根目錄下make即可以編譯相關(guān)的全部文檔。

?# 相關(guān)指令git clone https://github.com/ArduPilot/ardupilot_wiki.gitcd ardupilot_wiki./Sphinxsetup.shmake

編譯完成截圖

之前的版本目錄會抽風(fēng)來著，不過問題不大。新版本好像修復(fù)了這個問題

可以將主頁的相關(guān)路徑改為存放相關(guān)載具的路徑，這樣打開主頁即可跳轉(zhuǎn)相關(guān)的文檔

打開ardupilot\index.html，定位到177行左右，將https://ardupilot.org替換為存放html主頁的文件夾，比如file:///F:/Progroming/_Doc_Src/ardupilot_wiki/_build

之后編寫一個python小腳本就可以方便的管理文檔啦。

2.PX4文檔本地化

PX4的文檔比APM更多更雜，常用的是PX4的開發(fā)者手冊和Mavlink的開發(fā)者手冊，相關(guān)的repo鏈接如下

分別為Mavlink的開發(fā)者手冊，px4的開發(fā)手冊和用戶手冊，qgc的開發(fā)手冊

?https://github.com/mavlink/mavlink-devguide.githttps://github.com/PX4/dev.px4.io.githttps://github.com/PX4/px4_user_guide.githttps://github.com/mavlink/qgc-dev-guide.git

gitbook編譯文檔比之前的方便，不過編譯時各種插件還是有些bug(win上)，linux上可以成功編譯，安裝好gitbook之后進行編譯，生成_book目錄以及相關(guān)的語言。

?cd gitbook initgitbook build

不過缺點是無法直接單擊跳轉(zhuǎn)，考慮用Nginx輔助，安裝Nginx后修改配置文件

可以使用nginx -t命令查看nginx.conf的具體路徑

在配置文件中的http中添加下面的配置，可以添加多個，修改配置文件后重啟nginx

?server {listen ? ? ? ;location / { root ; index index.html index.htm;}}

然后就可以通過訪問127.0.0.1:愉快的使用本地文檔啦

伸手黨的福利

當然，懶得走上面的編譯流程可以直接下載編譯好的文檔，因為時間問題，沒有把所有的文檔都編譯為最新版本，有需自取。后綴為文檔的更新日期和git的commit hash，PX4文檔的hash實在找不到了，只記得對應(yīng)的版本了。

關(guān)注公眾號，并回復(fù)"無人機文檔"下載相關(guān)文件

《新程序員》：云原生和全面數(shù)字化實踐50位技術(shù)專家共同創(chuàng)作，文字、視頻、音頻交互閱讀

總結(jié)

以上是生活随笔為你收集整理的linux访问文档根目录之外的网页_开发文档加载不再卡顿，亿点点提升的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。