程序文档工具Read the Docs、Walden、System Browser Client、breathe介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Read the Docs(文档托管平台)、Walden(瓦尔登内网文档助手)、System Browser Client(Ruby 代码浏览器)、breathe(程序文档工具)。

1、Read the Docs(文档托管平台)

程序文档工具Read the Docs、Walden、System Browser Client、breathe介绍

Read the Docs 可以创建、托管和浏览文档,让文档可以被全文搜索和更易查找。您可以导入您使用任何常用的版本控制系统管理的文档,包括 Mercurial、Git、Subversion 和 Bazaar。我们支持 webhooks,因此可以在您提交代码时自动构建文档。并且同样也支持版本功能,因此您可以构建来自您代码仓库中某个标签或分支的文档。

特色如下:

免费文档托管:

我们将永久免费提供您的文档。我们帮助成千上万的开源项目共享他们的文档。

网络挂钩:

每当您将代码推送到您喜欢的版本控制系统时,无论是Git,Mercurial,Bazaar还是Subversion,我们都会自动构建您的文档。

多种格式:

当然,我们会为网络构建和托管您的文档,但也可以将它们作为PDF、单页HTML和电子阅读器进行查看。无需其他配置。

多种版本:

我们可以托管和构建您的文档的多个版本,因此拥有1.0版本的文档和2.0版本的文档就像在版本控制系统中拥有单独的分支或标记一样容易。

下载地址:https://readthedocs.org/

2、Walden(瓦尔登内网文档助手)

程序文档工具Read the Docs、Walden、System Browser Client、breathe介绍

或许是极人性化的一个文档管理框架,最适合部署在内网作为内网文档管理,url即目录层级。markdown+git+web搭配,让你一下子就喜欢上写文档分享。一分钟上手,有兴趣可挖掘隐藏技巧。

特点:

Markdown语法。

修改后实时展现,无编译。

多模板支持。

图片、附件上传,自动生成url。

多项目。

任意定义目录嵌套、定义文档,目录与文档均可中文(甚至推荐中文)。

文档、图片、附件同步保存至git,这下你安心了吧。

一、安装

零安装、零配置,无数据库,不需要composer,开箱即用。只需要你有一台安装了git命令行,php5.3,nginx环境的linux机器。

二、快速开始

vi Config.php

return [

// 项目留空保存文档和附件的git地址,可以是在github,好吧,不想公开,可以bitbucket。

// 1.php进程的用户的id_rsa.pub已添加到git的ssh-key。这样才可以推送markdown下的文件。

'git' => 'git@github.com:meolu/Walden-markdown-demo.git',

// 2.好吧,如果实在不想加key,可以直接明文用户名密码认证的http(s)地址也可以。

// 'git' => 'https://username:password@github.com/meolu/Walden-markdown-demo.git',

];

三、nginx简单配置

server {

listen       80;

server_name  Walden.dev;

root /the/dir/of/Walden;

index index.php;

# 建议放内网做文档服务

#allow 192.168.0.0/24;

#deny all;

location / {

try_files $uri $uri/ /index.php$is_args$args;

}

location ~ \.php$ {

try_files $uri =404;

fastcgi_pass   127.0.0.1:9000;

fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;

include        fastcgi_params;

}

}

自定义模板:

前端同学可以自己定义模板,在templates下新建一个模板目录,包含预览模板:markdown-detail-view.php,编辑模板:markdown-editor-view.php,然后修改Config.php的template为你的模板项目。

最后,当然希望你可以给此项目提个pull request,目前只有一个bootstrap的默认模板。

下载地址:https://gitee.com/mirrors/Walden

3、System Browser Client(Ruby 代码浏览器)

程序文档工具Read the Docs、Walden、System Browser Client、breathe介绍

System Browser Client 是一个用来浏览 Ruby 代码桌面应用程序,只需点击,就能获取一个模块或类的细节,并查看其命名空间或看到一个方法的来源。

浏览器不显示实时行为的信息。也就是说,如果你启动浏览器后,再定义一个类,浏览器不会显示出来。

注:这个软件目前还是 beta 版,包含 bugs,有时不会响应。

4、breathe(程序文档工具)

breathe 是  Doxygen 上面一个支持重新构建文本(reStructuredText )和全文检索(Sphinx),并支持生成 xml 文档的扩展工具。

注明

以上就是程序文档工具Read the Docs、Walden、System Browser Client、breathe的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章