使用Sphinx在 Android Studio 中生成项目API文档

github 项目地址 javasphinx
android studio里面自带了生成javadoc的功能。不过界面看着好不爽。我们使用 sphinx 是可以更换主题了。还不错。

简介

javasphinx是Sphinx文档系统的扩展，它增加了对Java项目文档的支持。它包括一个用于手动编写文档的Java域和一个javasphinx-apidoc实用程序，它将自动从现有的Javadoc标记生成API文档。

安装

javasphinx在Python包索引（PyPi）中可用，可以使用pip或easy_install等工具进行安装，

$ pip install javasphinx 

或者

$ easy_install -U javasphinx

安装 sphinx

$ pip install sphinx  

配置

在项目文件录下新建javadoc 的文件夹，在目录下运行

$ sphinx-quickstart 

填写一些版本，用户名之类的信息。

生成后的目录下有这些文件

image.png

更改主题样式

在conf.py 文件中设置样式

html_theme = "sphinx_rtd_theme"  

将java“domain”添加到sphinx，

这是嵌入到javasphinx包中，不遵循common .ext扩展名命名空间格式。
将这句话添加到conf.py中

extensions = ['javasphinx']

在索引中包含生成的文档

在javasphinx-apidoc命令的输出目录中，将生成一个packages.rst的目录文件，您可能希望将其包含在index.html的目录中。在index.rst中修改成如下配置：

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   packages.rst

生成文档

javasphinx包添加了shell工具javasphinx-apidoc，如果当前环境处于活动状态，则可以将其称为javasphinx-apidoc，

$ javasphinx-apidoc -o docs/source/ --title='<name_here>' ../path/to/java_dirtoscan

我们在根目录下使用

xushundeiMac:MVPDEMO xushun$ javasphinx-apidoc -o ./javadoc/ ./app/src/
xushundeiMac:MVPDEMO xushun$ cd javadoc/
xushundeiMac:javadoc xushun$ make html

将rst文件生成html .

image.png

打开index.html 便可以看到我们的项目API了

image.png