Sphinx使用
快速创建sphinx工程:sphinx-quickstart
rst文档
运行命令 sphinx-build -b html source build
超链接
.. _Sphinx官网: https://www.sphinx-doc.org/en/master/usage/installation.html
`Sphinx官网`_
`Phython官网 <https://www.python.org/>`_
注意空格:
预览
编译后:
参考:https://blog.csdn.net/m0_73063250/article/details/129629469
目录结构:
toctree表示目录结构。
maxdepth表示深度,我这里写1
效果:
然后再在demo网页下链接下一层目录:
如果第一级目录maxdepth写2的话会比较难看,效果如下:
画表格指令:python -m sphinxcontrib.xlsxtable --sheet=Test_7 --header-rows=1 name.xlsx
现在Excel里画个表格
输入指令:
python -m sphinxcontrib.xlsxtable --sheet=Test_7 --header-rows=1 name.xlsx
needtable:
参考:https://sphinx-needs.readthedocs.io/en/latest/directives/needtable.html#style
下图中两个文件夹,css会影响网页的宽度,sphinx-needs会影响needtable的缩进,具体影响方法还待研究
UML图需要plantuml.jar