草庐IT

SPHINX_PATH

全部标签

python - 如何在 Sphinx 中创建自定义指令

我目前正在记录用Python编写的restAPI。该项目的所有文档都是使用Sphinx创建的,对于RESTAPI,我想创建一些特殊指令。例如,假设我定义了这个资源:@resource("/user/",method="GET")defuser_details(email):"""Returnsdetailedinformationaboutauseraccount.:resourceGET:/user/:query_parama_param:Somekindofqueryparam."""#Dostuffandreturnuserdetails这基本上就是文档当前的样子。我希望能够为S

python - 为 `sphinx-apidoc` 自定义模板

我最近尝试使用sphinx-apidoc来自Sphinx帮助从Python项目的API生成Sphinx特定的reStructuredText。但是,我得到的结果是:有人知道我是否可以自定义sphinx-api用于输出的模板吗?具体来说,我想:删除所有“子模块”、“子包”和“模块内容”标题,以及让我的__init__.py文件中的docstring的结果直接显示在包下面,这样如果我单击包名称,我首先看到的是包文档。目前,该文档位于每个包部分末尾的稍微奇怪的“模块内容”标题下。我认为“子模块”和“子包”标题是多余的,因为包/模块的正常标题是“xxx.yyy包”和“xxx.yyy.zzz模块

python - 为 `sphinx-apidoc` 自定义模板

我最近尝试使用sphinx-apidoc来自Sphinx帮助从Python项目的API生成Sphinx特定的reStructuredText。但是,我得到的结果是:有人知道我是否可以自定义sphinx-api用于输出的模板吗?具体来说,我想:删除所有“子模块”、“子包”和“模块内容”标题,以及让我的__init__.py文件中的docstring的结果直接显示在包下面,这样如果我单击包名称,我首先看到的是包文档。目前,该文档位于每个包部分末尾的稍微奇怪的“模块内容”标题下。我认为“子模块”和“子包”标题是多余的,因为包/模块的正常标题是“xxx.yyy包”和“xxx.yyy.zzz模块

python - os.path.dirname(os.path.abspath(__file__)) 和 os.path.dirname(__file__) 的区别

我是Django项目的初学者。Django项目的settings.py文件包含这两行:BASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))PROJECT_ROOT=os.path.dirname(os.path.abspath(__file__))我想知道两者的区别,因为我认为两者都指向同一个目录。如果您能提供一些链接os.path函数,这也会有很大的帮助。 最佳答案 BASE_DIR指向PROJECT_ROOT的parent目录。您可以将这两个定义

python - os.path.dirname(os.path.abspath(__file__)) 和 os.path.dirname(__file__) 的区别

我是Django项目的初学者。Django项目的settings.py文件包含这两行:BASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))PROJECT_ROOT=os.path.dirname(os.path.abspath(__file__))我想知道两者的区别,因为我认为两者都指向同一个目录。如果您能提供一些链接os.path函数,这也会有很大的帮助。 最佳答案 BASE_DIR指向PROJECT_ROOT的parent目录。您可以将这两个定义

router.addRoute()报错 Uncaught Error: [vue-router] “path” is required in a route configuration

一、场景:后端动态传递路由,前端通过router.addRoute()添加时报错。UncaughtError:[vue-router]“path”isrequiredinarouteconfiguration(未捕获错误:[vue-router]:"路径"在路由配置中是必需的)二、分析:查看官方的接口文档:VueRouter_addRoute接口,等于说addRoute()实际接收的是一个类型为RouteRecordRaw的对象。而我错误的将后台返回的数组直接作为参数放入了addRoute()。三、解决方案:将后端返回的动态路由数组边遍历边加入router//关键代码,遍历后放入rewrite

python - IPython 导入失败和 python sys.path 一般

我正在关注这个post让一个ipython统治所有的virtualenvs。据我了解,该帖子的主要思想是当在virtualenv中时,ipython找不到它的模块。(a-virtualenv)me@pc:~$ipythonTraceback(mostrecentcalllast):File"/usr/bin/ipython",line19,infromIPython.frontend.terminal.ipappimportlaunch_new_instanceImportError:NomodulenamedIPython.frontend.terminal.ipapp为了解决这个问

python - IPython 导入失败和 python sys.path 一般

我正在关注这个post让一个ipython统治所有的virtualenvs。据我了解,该帖子的主要思想是当在virtualenv中时,ipython找不到它的模块。(a-virtualenv)me@pc:~$ipythonTraceback(mostrecentcalllast):File"/usr/bin/ipython",line19,infromIPython.frontend.terminal.ipappimportlaunch_new_instanceImportError:NomodulenamedIPython.frontend.terminal.ipapp为了解决这个问

python - 在不修改sys.path或第三方软件包的情况下,在Python软件包中导入供应商依赖性

概要我正在为Anki(开源抽认卡程序)开发一系列附加组件。Anki附加组件以Python软件包的形式提供,其基本文件夹结构如下所示:anki_addons/addon_name_1/__init__.pyaddon_name_2/__init__.py基本应用程序将anki_addons附加到sys.path,然后将其与import导入每个add_on。我一直试图解决的问题是找到一种可靠的方式来将运送的包裹及其依赖项与我的附加组件一起使用,同时又不污染全局状态或不退回对供应商包裹的手动编辑。细节具体来说,给定这样的附加结构...addon_name_1/__init__.py_vend

python - 在不修改sys.path或第三方软件包的情况下,在Python软件包中导入供应商依赖性

概要我正在为Anki(开源抽认卡程序)开发一系列附加组件。Anki附加组件以Python软件包的形式提供,其基本文件夹结构如下所示:anki_addons/addon_name_1/__init__.pyaddon_name_2/__init__.py基本应用程序将anki_addons附加到sys.path,然后将其与import导入每个add_on。我一直试图解决的问题是找到一种可靠的方式来将运送的包裹及其依赖项与我的附加组件一起使用,同时又不污染全局状态或不退回对供应商包裹的手动编辑。细节具体来说,给定这样的附加结构...addon_name_1/__init__.py_vend