other
#####


内置
====

这些扩展是内置的，可以通过 extensions 配置值

sphinx.ext.autodoc::

    包括文档字符串中的文档

sphinx-ext-napoleon::

    支持numpy和google风格的docstrings


sphinx.ext.todo::

    支持todo items

sphinx.ext.viewcode::

    代码高亮

sphinx.ext.linkcode::

    添加外部代码链接

sphinx.ext.intersphinx::

    链接到其他项目的文档

sphinx.ext.autosectionlabel::

    允许引用节使用其标题

sphinx.ext.autosummary::

    生成自动生成摘要


sphinx.ext.coverage::

    收集文档覆盖率统计

sphinx.ext.doctest::

    文档中的测试片段

sphinx.ext.duration::

    测量sphinx处理的持续时间

sphinx.ext.extlinks::

    缩短外部链接的标记


sphinx.ext.githubpages::

    在GitHub页面中发布HTML文档


sphinx.ext.graphviz::

    添加graphviz图


sphinx.ext.ifconfig::

    包括基于配置的内容

sphinx.ext.imgconverter::

    使用ImageMagick的参考图像转换器

sphinx.ext.inheritance_diagram::

    包括继承关系图


第三方扩展
==========

* https://bitbucket.org/birkenfeld/sphinx-contrib 🚫
* https://github.com/thewtex/sphinx-contrib
* https://www.osgeo.cn/sphinx/usage/extensions/index.html
* https://github.com/yoloseem/awesome-sphinxdoc
* https://sphinxext-survey.readthedocs.io/


* actdiag: embed activity diagrams by using actdiag
* nwdiag: embed network diagrams by using nwdiag
* blockdiag: embed block diagrams by using blockdiag
* plantuml: embed UML diagram by using PlantUML
* seqdiag: embed sequence diagrams by using seqdiag




::

    pip install sphinxcontrib-actdiag
    pip install sphinxcontrib-nwdiag
    pip install sphinxcontrib-blockdiag  
    pip install sphinxcontrib-plantuml
    pip install sphinxcontrib-seqdiag 
    pip install sphinxcontrib-toc



literalinclude 扩展
===================

* https://github.com/dgarcia360/sphinxcontrib-viewsource
* https://github.com/mgeier/sphinx-last-updated-by-git
* https://github.com/SuperKogito/sphinxcontrib-pdfembed