轻松地将sphinx文档集成到您的网站中。
django-sphinxdoc的Python项目详细描述
django sphinxdoc–将sphinx文档嵌入django站点
这个django应用程序允许您集成任何 Sphinx直接将文档放入 Django支持的网站,而不仅仅是提供静态文件。
Django SphinxDoc可以处理多个Sphinx项目并提供 一个由Haystack驱动的搜索。
要求
此应用程序要求python≥3.6、django≥2.0、sphinx≥1.0和 干草堆≥2.8.0。
安装
只需使用PIP:
$ pip install django-sphinxdoc
如果您想要最新的开发版本:
$ git clone git@gitlab.com:sscherfke/django-sphinxdoc.git $cd django-sphinxdoc $ mkvirtualenv django-sphinxdoc $ pip install -e .
用法
文档可以在docs/
目录或
https://django-sphinxdoc.readthedocs.io/en/latest/。