如何将模块导入Sphinx

How to import module to Sphinx(如何将模块导入Sphinx)
本文介绍了如何将模块导入Sphinx的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

import myModule as myModule

使用此代码可以导入,我可以制作我的文档

import myPackage.myModule as myModule

这样我就得到了

&q;没有名为myPackage.myModule的模块

此文件是否存在于根目录或myPackage目录中并不重要。

在我没有提到myModule的RST文件中,我想记录仅导入此模块的其他文件。

推荐答案

Sphinx需要能够导入您的代码,以生成类和函数的文档。您可能需要将项目的根文件夹添加到Sphinx中的sys.path中。您可以从Sphinxconf.py文件中执行此操作:

import sys
import os
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))

'..'替换为项目根的相对路径。

这篇关于如何将模块导入Sphinx的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)