如何解决ReadTheDocs 问题:在 doc 文件夹外导入文件
我在上传 ReadTheDoc 时遇到了一个小但非常令人恼火的问题,它占用了我的 travis-ci 学分!
我的项目具有以下架构:
|-PyMieSim-|-tests-|-test0.py
| | |-test1.py
| | |-test2.py
| |
| |-docs-|-conf.py
| |-index.rst
在 index.rst 文件中,我想包含 test0.py、test1.py 和 test2.py 文件。 所以在 index.rst 我放了类似的东西:
.. literalinclude:: ../tests/test0.py
:language: python
:linenos:
尽管它确实可以使用“make html”在本地编译和工作,但它不在 ReadTheDocs 上。 我知道 RDT 建议使用相对路径,但是当我远程上传和构建时,我可以看到架构发生了变化。因此,如果它与本地不同,则获取相对路径变得非常困难。 有没有办法获取项目根目录(PyMieSim 文件夹)的绝对路径?或者我可以将测试文件链接到 conf.py 中的某个位置吗?
最好的方法是在本地和远程工作。 如果有人能对此有所帮助,我将不胜感激!
编辑:
好吧,我终于让它工作了,第一件事是,我愚蠢的浏览器在查看 RTD 的新版本时总是在查看缓存,所以它从未真正更新我的 git push(废话!)。为这个感到羞耻。
看起来像将 __init__.py
文件添加到测试目录和子目录有助于使其工作。我也为那个感到羞耻!
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。