Bonky Zhu
If someone is able to show me that what I think or do is not right, I will happily change, for I seek the truth, by which no one was ever truly harmed. It is the person who continues in his self-deception and ignorance who is harmed.

如何把一个网站转换为Dash的docset

我是dash的老用户了,dash的好处就是比较方便的一站式的查询文档,然后dash的社区也比较活跃。但不过还是有一些文档是dash没有的,我们可以通过以下步骤制作一个dash的文档:

首先第一步是下载整个网页,这里直接使用wget进行下载:

wget -r -p -k -np https://allenai.github.io/allennlp-docs/


下载完成后,到 github下载别人做好的一个小脚本 html2dash.py, 下载完成后,按照以下规则执行命令:

$ /html2dash.py -h
usage: html2dash.py [-h] [-n NAME] [-d PATH] [-i FILENAME] [-p INDEX_PAGE]
                    SOURCE
  SOURCE                HTML 文档的存放文件夹

  -n NAME, --name NAME  文档的名字
  -d PATH, --destination PATH
                        保存文档的位置
  -i FILENAME, --icon FILENAME
                        加入文档的图标
  -p INDEX_PAGE, --index-page INDEX_PAGE
                        设置 index 页面


对于上面的那个例子我们执行:

./html2dash.py -n allennlp  allennlp-docs


可以看到在当前目录下生成了个 allennlp.docset,点击即可导入dash了~

屏幕快照 2019-11-08 下午9.51.18

效果图如下,缺点是没有Classes、Functions、Types等属性,但也没关系啦

屏幕快照 2019-11-08 下午9.52.19

Share

You may also like...

发表评论