如何解决Sphinx 文档:HTML 文档的自定义图像目录和 _static 目录
我是开发 Python 包的相对初学者。在存储库的根目录下有两个重要的目录:images
和 docs
。前者包含一些我想放在文档中的 png 和 svg 文件,后者是我运行 sphinx-quickstart
的地方。因此我无法更改该布局我必须让 Sphinx 知道在构建文档时使用顶级 images
目录。
根据我在互联网上找到的内容,我调整了 conf.py
文件:
# Add any paths that contain custom static files (such as style sheets) here,# relative to this directory. They are copied after the builtin static files,# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static','../images']
在 index.rst
中,我必须指向图像文件本身:
.. image:: ../images/scheme.svg
:width: 500
:alt: schematic
:align: center
设置好这两个后,我运行 make html
并得到干净的日志,但输出目录有点奇怪......构建完成后,我有一个 docs/_build/html
目录,其中包含 {{ 1}} 和 _static
子目录(等等)。我觉得奇怪的是,在 _images
中,我看到根级 docs/_build/html/_static
的所有内容都被复制了,而(同时)在 images
中,我只有 {{1} }.所以基本上这个文件被复制到这两个子目录中......
这对我来说看起来不太干净……我应该如何调整这个设置?
回复bad_coder的评论:
下面我将粘贴一个带有目录结构的树(只保留相关元素):
docs/_build/html/_images
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。