cp2k离线api文档制作(结合Dash或Zeal使用)

casea

最近在学pyrosetta，跟随谷雨老师的教程时，发现老师自己制作了pyrosetta的离线api查询文档，通过dash程序可以很方便的查找关键字。
举一反三，cp2k的关键词很多，而且日常访问网页查询时可能会出现网络波动。那么是否可以自行构建docset文档结合dash使用呢？
在查询资料之后，Dash程序只适用于Macos，Zeal支持windows和linux(Zeal是借鉴了Dash编写的）。软件安装很简单查看官网即可(提供的网盘文件中提供了解压即用的Zeal程序包)
目前，Zeal内置了很多官方api文档。但是很多程序的离线api文档需要自己制作。在此，提供制作流程，于此同时网盘文件中提供了对应的已经制作好的cp2k.docset文件，只需将其放入zeal程序文件夹中的docset文件夹即可。

链接：https://pan.baidu.com/s/1EYiVDrFrGxEHovN_-k5DLg
提取码：afwm

效果图：

制作流程： 使用centos8系统生成，仅供参考，可以直接使用网盘的资料
1. mkdir docset
2. cd docset
3. wget -m https://manual.cp2k.org/cp2k-2022_1-branch/index.html***2022/08/12更新***
在@highlight 的指点下，也可以采用如下方法生成html文件
这是官方给的说明https://manual.cp2k.org/cp2k-9_1-branch/generate_manual_howto.html

假设你有编译好的 cp2k.psmp，执行 cp2k.psmp --xml 得到 cp2k_input.xml
yum install java saxon
在 xml2html 里修改 export SAXON=/usr/share/java/saxon.jar
执行 ./xml2htm

4. mkdir -p cp2k.docset
5. mkdir -p cp2k.docset/Contents/Resources/Documents
6. mv manual.cp2k.org/cp2k-2022_1-branch/* cp2k.docset/Contents/Resources/Documents/
7. vi cp2k.docset/Contents/Info.plist

1. <?xml version="1.0" encoding="UTF-8"?>
   
2. <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
   
3. <plist version="1.0">
   
4. <dict>
   
5.         <key>CFBundleIdentifier</key>
   
6.         <string>CP2K</string>
   
7.         <key>CFBundleName</key>
   
8.         <string>CP2K</string>
   
9.         <key>DocSetPlatformFamily</key>
   
10.         <string>CP2K</string>
    
11.         <key>isDashDocset</key>
    
12.         <true/>
    
13. </dict>
    
14. </plist>
    

复制代码

8. > sqlite3 cp2k.docset/Contents/Resources/docSet.dsidx
    > CREATE TABLE searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT);
  > .exit
9. python docset.py

1. # docset.py
   
2. #!/usr/local/bin/python
   
3. 
   
4. import os, re, sqlite3
   
5. from bs4 import BeautifulSoup, NavigableString, Tag
   
6. 
   
7. conn = sqlite3.connect('/home/casea/CASEADATA/docset/cp2k.docset/Contents/Resources/docSet.dsidx')
   
8. cur = conn.cursor()
   
9. 
   
10. try: cur.execute('DROP TABLE searchIndex;')
    
11. except: pass
    
12. cur.execute('CREATE TABLE searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT);')
    
13. cur.execute('CREATE UNIQUE INDEX anchor ON searchIndex (name, type, path);')
    
14. 
    
15. docpath = '/home/casea/CASEADATA/docset/cp2k.docset/Contents/Resources/Documents'
    
16. 
    
17. page = open(os.path.join(docpath,'index.html')).read()
    
18. soup = BeautifulSoup(page)
    
19. 
    
20. any = re.compile('.*')
    
21. for tag in soup.find_all('a', {'href':any}):
    
22.     name = tag.text.strip()
    
23.     if len(name) > 1:
    
24.         path = tag.attrs['href'].strip()
    
25.         if path != 'index.html':
    
26.             cur.execute('INSERT OR IGNORE INTO searchIndex(name, type, path) VALUES (?,?,?)', (name, 'func', path))
    
27.             print('name: %s, path: %s' % (name, path))
    
28. 
    
29. conn.commit()
    
30. conn.close()

复制代码

10. cp cp2k.docset/Contents/Resources/Documents/favicon.png cp2k.docset/icon@2x.png
11. 在修改favicon.png的像素尺寸为16x16，并保存为icon.png
12. 将生成的cp2k.docset复制到zeal程序文件夹中得docset文件夹下。

highlight

可以不用 wget 吧，使用 tools/manual 直接生成对应版本的 manual 或许更简单

casea

highlight 发表于 2022-8-12 12:46
可以不用 wget 吧，使用 tools/manual 直接生成对应版本的 manual 或许更简单

wget这一步确实有点耗时，这方法也是借鉴过来的。
请教一下使用tool/manual生成是如何操作的

highlight

casea 发表于 2022-8-12 13:35
wget这一步确实有点耗时，这方法也是借鉴过来的。
请教一下使用tool/manual生成是如何操作的

就是按照 README 里写的来
假设你有编译好的 cp2k.psmp，执行 cp2k.psmp --xml 就能得到 cp2k_input.xml
安装 yum install java saxon
然后在 xml2html 里修改 export SAXON=/usr/share/java/saxon.jar
执行 ./xml2htm 就行了