sphinx的fortran域和autodoc扩展
sphinx-fortran的Python项目详细描述
目的
这个包提供了两个sphinx(http://sphinx.pocoo.org/)扩展 到Fortran(90)语言:
- sphinxfortran.fortran_domain:fortran的sphinx域。
- sphinxfortran.fortran_autodoc:自动记录Fortran代码。
许可证
此包与vacumm(http://www.ifremer.fr/vacumm)具有相同的许可证 来源:cecill-a (http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html), 与GPL兼容。
先决条件
sphinx和numpy包。
安装
使用pip:
pip install sphinx-fortran
来源:
git clone https://github.com/VACUMM/sphinx-fortran.git cd sphinx-fortran python setup.py install
您也可以从ifremer的forge下载资源: https://forge.ifremer.fr/frs/?group_id=93
快速启动
将此扩展添加到sphinxconf.py。
在变量中列出Fortran源文件 ^你的conf.py中的{tt7}$。
在rst文件中使用 指令如下:
.. f:automodule:: mymodule
错误和请求
请转到github页面: https://github.com/VACUMM/sphinx-fortran/issues