0 前言 写文档是开发人员日常工作中的一项重要内容,除了word之外,我更偏爱使用标记语言(Markup Language).使用标记语言,可以利用简单.免费的文本编辑器(记事本,vim, emacs...)编写文档并设置格式,再生成html或pdf等格式,或者直接把编辑好的文件传到github或wiki上面 ,通过浏览器可以直接查看带有格式的文档. 目前标记语言主要有两种,Markdown和reStructuredText(简称reST).该使用哪一种是一个见仁见智的选择,我在这里就不比较它们…

利用Sphinx编写文档 1.Sphinx简介和使用理由 ================= Sphinx是一个用Python语言编写而成的文档编写工具.用Sphinx编写文档的时候,用户只需要编写符合Sphinx格式要求的纯文本源文件,然后通过Sphinx的命令就可以把纯文本源文件编译成html.pdf等常用格式的文档,这样就实现了通过文本文件自动生成html.pdf等格式文档的功能. 编写文档直接用Word不就是挺好的吗?为什么又要用Sphinx来写纯文本格式的文档呢? 这是因为Sphinx…

操作系统 : Windows7_x64 Python 版本 : 2.7.10 Sphinx 版本 : 官方网址:http://sphinx-doc.org github地址: https://github.com/sphinx-doc/sphinx 安装Sphinx 使用pip安装: pip install -U Sphinx pip install sphinx_rtd_theme 从源码安装: git clone https://github.com/sphinx-doc/sphinx cd…

此sphinx可不是彼sphinx,此篇是指生成文档的工具,是python下最流行的文档生成工具,python官方文档即是它生成,官方网站是http://www.sphinx-doc.org,这里是一个中文翻译站:https://zh-sphinx-doc.readthedocs.io readthedocs.org(下文简称rtd)是一个基于sphinx.mkdocs的在线文档托管网站,支持git.subversion等版本控制系统,并提供多版本.翻译.下载文档等,颇受欢迎. 此篇文章记录了本…

简而言之,要为API编写文档,文档注释是最好,最有效的途径.对于所有可导出的API元素来说,使用文档注释应该被看作是强制性的.要 采用一致的风格来遵循标准的约定.记住,在文档注释内部出现任何的HTML标签都是允许的,但是HTML元字符必须要经过转义.…

Tips 书中的源代码地址:https://github.com/jbloch/effective-java-3e-source-code 注意,书中的有些代码里方法是基于Java 9 API中的,所以JDK 最好下载 JDK 9以上的版本. 56. 为所有已公开的API元素编写文档注释 如果API要可用,就必须对其进行文档化.传统上,API文档是手工生成的,保持文档与代码的同步是一件苦差事.Java编程环境使用Javadoc实用程序简化了这一任务.Javadoc使用特殊格式的文档注释(通常称为…

作者这里以osgearth文档为例,感觉这种生成文档的方式比较好,生成的html文档是支持搜索的,感谢开源工作者的奉献.赞一个 1. 下载并安装python for windows:https://www.python.org/downloads/windows/ 2.下载安装setup tools下载easy_stall.py 并运行https://pypi.python.org/pypi/setuptools#windows-7-or-graphical-install,可以找到window…

Markdown 是一种轻量级标记语言,用来编写文本文档,一般后缀名为.md.该语言在 2004 由约翰·格鲁伯(John Gruber)创建. 由于Markdown 语法简单,易读易写,变得越来越通用.目前很多的博客类型的网站都支持Markdown 语法来编写文档,例如CSDN,知乎,博客园,简书等. 使用Markdown 语法,可以将自己的文章很容易(基本无需修改)的迁移到其它网站(只要这个网站支持Markdown 语法). 0,编辑工具 Typora 是一款不错的Markdown 编辑工具…

Markdown 介绍 Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档. Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建. Markdown 编写的文档可以导出 HTML .Word.图像.PDF.Epub 等多种格式的文档. Markdown 编写的文档后缀为 .md, .markdown. Markdown 标题 Markdown标题有两种格式. 1.使用 = 和 - 标记一级和二级标题 = 和- 标记语法格式如下:…

 最近在CentOS6.4下使用其默认的文档查看器打开PDF文档时出现乱码的方块,有两种方法可以解决.    方法一:修改/etc/fonts/conf.d/49-sansserif.conf文件,如下: <?xml version="1.0"?> <!DOCTYPE fontconfig SYSTEM "fonts.dtd"> <fontconfig> <!-- If the font still has no gener…