如何生成 RTD 文档以供离线阅读?
How do I generate RTD documentation for offline reading?
有没有方便的方法来阅读和访问 Python 包的项目文档 - f.e。像 ReadTheDocs 文档(https://beautiful-soup-4.readthedocs.org/en/latest/ 在这种情况下 bs4)- 离线?
我知道有pydoc-server、docstrings等等。但是,这些不包括完整的文档,如教程、快速入门等。Python 中是否有与 R 中的小插图等效的功能?
关于 RtD 的文档是使用 Sphinx 生成的。较大的 Python 包将在其源存档中包含生成此文档所需的文件,通常可通过 make doc
或以特定格式通过例如make html
或 make pdf
。具体对于 BS4,makefile 在 docs/
下,运行 make help
将显示哪些进一步的目标可用。
有没有方便的方法来阅读和访问 Python 包的项目文档 - f.e。像 ReadTheDocs 文档(https://beautiful-soup-4.readthedocs.org/en/latest/ 在这种情况下 bs4)- 离线?
我知道有pydoc-server、docstrings等等。但是,这些不包括完整的文档,如教程、快速入门等。Python 中是否有与 R 中的小插图等效的功能?
关于 RtD 的文档是使用 Sphinx 生成的。较大的 Python 包将在其源存档中包含生成此文档所需的文件,通常可通过 make doc
或以特定格式通过例如make html
或 make pdf
。具体对于 BS4,makefile 在 docs/
下,运行 make help
将显示哪些进一步的目标可用。