API文档生成(sphinx)

这篇具有很好参考价值的文章主要介绍了API文档生成(sphinx)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

1.安装

pip install Sphinx

2.使用

2.1文档手册

Sphinx 1.3.1 中文手册 (推荐查看)教程https://fengxc.me/基于python注释使用sphinx自动化生成API文档.html

2.2创建工程

新建一个文件夹sphinx_test, 并创建两个子文件夹code, doc。目录结构如下:API文档生成(sphinx),sphinx,全文检索,搜索引擎

进去到doc目录, 打开powershell, 执行下边命令创建工程sphinx-quickstartAPI文档生成(sphinx),sphinx,全文检索,搜索引擎

输入y,回车API文档生成(sphinx),sphinx,全文检索,搜索引擎

在这里设置工程名称、作者、版本信息、语言(中文用zh_CN表示)等API文档生成(sphinx),sphinx,全文检索,搜索引擎

2.3修改配置

打开doc/source/conf.py, 修改一些内容

// 如果需要自动生成API文档,sphinx.ext.autodoc这个很关键
extensions = [
    'sphinx.ext.autodoc',
]

// 配置项目路径:
import os
import sys
sys.path.insert(0, os.path.abspath('../../code'))   // 这里的地址是代码路径地址 如果code下面有__init__.py文件,则可以路径为../../。
2.4生成rst文件

在code文件夹中编写自己的python代码API文档生成(sphinx),sphinx,全文检索,搜索引擎

API文档生成(sphinx),sphinx,全文检索,搜索引擎

使用sphinx-apidoc生成rst文件,-o 后面跟的是保存rst文件的路径,你的index.rst文件在哪个目录,就指定哪个目录,然后最后面是代码路径

sphinx-apidoc -o ./source ../codeAPI文档生成(sphinx),sphinx,全文检索,搜索引擎

2.5生成html

在doc目录下,使用make命令生成html文件

使用前,先清除一下之前的生成文件 .\make.bat cleanAPI文档生成(sphinx),sphinx,全文检索,搜索引擎

生成html, (也可以生成pdf和其他的文档类型) .\make.bat htmlAPI文档生成(sphinx),sphinx,全文检索,搜索引擎

这块有个红色的warning,我们后面再来解决这个问题,先暂且放着。

2.6效果展示

现在我们用浏览器打开doc/build/html/index.html,显示如下:API文档生成(sphinx),sphinx,全文检索,搜索引擎

这是不是和我们平时看到的python文档不太一样,那是因为我们的主题没有选对

2,7改变sphinx主题

安装主题pip install sphinx_rtd_theme

导入模块:修改source/conf.py文件

# 导入模块
import sphinx_rtd_theme

# html_theme = "alabaster"修改如下,加上html_theme_path
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

重新生成html

// 在doc目录下执行
.\make.bat clean
.\make.bat html

效果展示API文档生成(sphinx),sphinx,全文检索,搜索引擎

问题修复

不知道大家有没有发现,上面生成的文档左边导航栏下面是没有内容CONTENTS的,本来应该是像下面这样的:API文档生成(sphinx),sphinx,全文检索,搜索引擎

还记得上面提到的在make html时的那个Warning么,这就是那个导致的

那个warning的意思是说,modules.rst没有被包含,没有被什么包含呢,是没有在index.rst里面包含,毕竟我们显示是用的index.rst。

所以我们需要在index.rst里面加上modules,不知道是不是这个版本的问题,我在好多教程里面都没有提到这个,所以踩了个坑。

修改后如下(source/index.rst):

.. SphinxTest documentation master file, created by
   sphinx-quickstart on Mon Jan  8 16:51:13 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SphinxTest's documentation!
======================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   modules


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

之后,再运行make clean和make html,则warning消失,页面上会显示CONTENTS文章来源地址https://www.toymoban.com/news/detail-817116.html

到了这里,关于API文档生成(sphinx)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【迅搜03】全文检索、文档、倒排索引与分词

    今天还是概念性的内容,但是这些概念却是整个搜索引擎中最重要的概念。可以说,所有的搜索引擎就是实现了类似的概念才能称之为搜索引擎。而且今天的内容其实都是相关联的,所以不要以为标题上有四个名词就感觉好像内容很多一样,其实它们都是联系紧密的,一环套

    2024年02月03日
    浏览(39)
  • Lucene和Solr和Elasticsearch区别,全文检索引擎工具包Lucene索引流程和搜索流程实操

    我们生活中的数据总体分为两种: 结构化数据和非结构化数据 。 结构化数据 :指具有固定格式或有限长度的数据,如数据库,元数据等。 非结构化数据 :指不定长或无固定格式的数据,如 互联网数据、邮件,word文档等。 非结构化数据又有一种叫法叫全文数据 按照数据的

    2024年02月03日
    浏览(42)
  • Java调用Elasticsearch API实现全文检索,搭配MinIO文件存储

    应用背景: 对存储在MinIO服务器的文件实现全文检索。也可以是其他服务器或本地文件,本文仅详细介绍MinIO文件的读取及转换。通过Elasticsearch的Ingest-Attachment插件抽取文件内容,支持Word、Excel、PDF、TXT等格式文件,无需手动解析文件内容。 上代码,详细解释可以阅读注释、

    2024年02月11日
    浏览(42)
  • ElasticSearch 实现 全文检索 支持(PDF、TXT、Word、HTML等文件)通过 ingest-attachment 插件实现 文档的检索

    Attachment 插件是 Elasticsearch 中的一种插件,允许将各种二进制文件(如PDF、Word文档等)以及它们的内容索引到 Elasticsearch 中。插件使用 Apache Tika 库来解析和提取二进制文件的内容。通过使用 Attachment 插件,可以轻松地在 Elasticsearch 中建立全文搜索功能,而无需事先转换二进制

    2024年02月05日
    浏览(53)
  • 17、全文检索 -- Elasticsearch -- 使用 反应式 RestClient (ReactiveElasticsearchClient)操作 Es 服务器(增、删、查 :索引库和文档)

    Elasticsearch 所提供 RestHighLevelClient 本身提供了 【同步编程】 和 【异步编程】两种模型。 Elasticsearch 官方并未提供反应式的 RestClient : 因此 Spring Data Elasticsearch 额外补充了一个 ReactiveElasticsearchClient,用于提供反应式API支持, ReactiveElasticsearchClient 相当于 RestHighLevelClient 的反应式

    2024年04月28日
    浏览(46)
  • 09、全文检索 -- Solr -- SpringBoot 整合 Spring Data Solr (生成DAO组件 和 实现自定义查询方法)

    测试类使用 solrClient 进行添加、查询、删除文档的操作在这篇的代码基础上继续演示的 两篇文章的区别: 上一篇是通过SolrClient 连接 Solr,然后用 SolrClient 来调用查询方法进行全文检索 这一篇是 自定义dao组件,通过继承CrudRepository 接口,用 dao 接口来调用查询方法进行全文检

    2024年02月19日
    浏览(56)
  • API文档生成(sphinx)

    1.安装 pip install Sphinx 2.使用 2.1文档手册 Sphinx 1.3.1 中文手册 (推荐查看)教程https://fengxc.me/基于python注释使用sphinx自动化生成API文档.html 2.2创建工程 新建一个文件夹sphinx_test, 并创建两个子文件夹code, doc。目录结构如下: 进去到doc目录, 打开powershell, 执行下边命令创建工程 s

    2024年01月23日
    浏览(36)
  • 全文检索-Elasticsearch-进阶检索

    本文记录谷粒商城高级篇的 Elasticsearch 进阶检索部分,续上之前记录的 Elasticsearch入门篇。 ES 支持两种基本方式检索 : 一个是通过使用 REST request URI 发送搜索参数(uri + 检索参数) 另一个是通过使用 REST request body 来发送它们(uri + 请求体) 请求体中写查询条件,语法: 示例

    2024年02月03日
    浏览(87)
  • 【全文检索】sqlite-fts4和pgsql的全文检索对比

    因为是Android项目,老系统中的全文检索是采用sqlite自带的fts4,然而后续由于地图要素全部转为线上,全文检索也需要同步在线查询,所以将整个全文检索的功能迁移到pgsql中。目前这块功能基本结束,这里来对两种全文检索方案做一个对比总结。 相比与fts5,fts4的好处是原生

    2024年02月05日
    浏览(45)
  • 全文检索-Es-初步检索(三)

    #为jmeter返回的结果 jmeter测试结果 请求头 http请求 put 返回结果 再次发送请求 post不带/带id保存 不带id 结果 二次请求结果 带id保存 结果 二次请求结果 结论 发送请求 查询-查看结果树 增加判断,确定是否修改 结果 查看修改是否成功 结果 更新文档 post/put带_update的请求(会比

    2024年02月14日
    浏览(43)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包