首页 > 其他分享 >sphinx使用初体验笔记

sphinx使用初体验笔记

时间:2022-12-08 19:34:10浏览次数:42  
标签:index 初体验 sphinx global pypi 笔记 html pip

 1 #安装
 2 pip install sphinx -i https://pypi.tuna.tsinghua.edu.cn/simple
 3 
 4 #更换国内源
 5  清华源
 6 pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
 7 
 8 # 阿里源
 9 pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
10 # 腾讯源
11 pip config set global.index-url https://mirrors.cloud.tencent.com/pypi/simple
12 # 豆瓣源
13 pip config set global.index-url http://pypi.douban.com/simple/
14 
15 #换回默认源
16 pip config unset global.index-url
17 
18 #离线下载安装包
19 pip download 包名 -d "路径(windows下双引号来表示文件夹)"
20 #离线安装
21 pip install <.whl 或者源文件包名>
22 
23 #开始
24 sphinx-quickstart
25 
26 #编译
27 make html
28 
29 #Sphinx 默认不支持 Markdown 语法,但可以通过 recommonmark 插件来支持。另外,如果需要支持 markdown 的表格语法,还需要安装 sphinx-markdown-tables 插件。这两个插件其实我们前面已经安装好了,现在只需要在 conf.py 配置文件中添加扩展支持即可。
30  extensions = [
31      'recommonmark',
32      'sphinx_markdown_tables'
33  ]
34 
35 #遇到的问题 搜索不支持中文
36 #解决方案
37 pip install jieba
38 #在conf.py配置文件中添加html_search_language = 'zh'并重新make html
39 
40 #进阶 自动编译 sphinx-autobuild source build/html
41 #https://studynotes.readthedocs.io/zh/main/struct/extend/autobuild.html

 

标签:index,初体验,sphinx,global,pypi,笔记,html,pip
From: https://www.cnblogs.com/ligongzi/p/16967066.html

相关文章

  • Docker学习笔记十:Docker安装Nginx
    准备下载命令:dockerpullnginx安装可参考Docker Hub官网说明的镜像的用法  安装 第一步:简单安装创建容器命令:dockerrun-d--name=nginx-p8111:8080......
  • python基础之条件判断语句(笔记)
    #条件判断语句(if语句)#语法:if条件表达式: #     代码块#执行的流程:if语句在执行时,会先对条件表达式进行求值判断,# 如果为True,则执行if后的语句# ......
  • 「文化课」一个政治学考的笔记
    首先,我没上过高中政治常规课。所有制:公有(\(\neq\)国有)制为主体,多种所有制经济共同发展。提高国有占国民经济比重影响力、竞争力、控制力。公&非公:二者在社会主义市......
  • 前端笔记_3_页面变灰
    html{-moz-filter:grayscale(100%);-ms-filter:grayscale(100%);-o-filter:grayscale(100%);-webkit-filter:grayscale(1);-webkit-filter:......
  • Github Actions 学习笔记
    GithubActions是什么?GithubActions官方介绍:GitHubActions是一个持续集成和持续交付(CI/CD)平台,允许您自动化构建、测试和部署管道。您可以创建构建和测试存储库中的每......
  • zlib使用笔记
    zlib使用过程compress压缩过程:deflateInit()->deflate()->deflateEnd(); uncompress对应的解压过程inflateInit()-> inflate()-> inflateEnd(); compre......
  • 自动化测试高手课-学习笔记
    课程链接github链接Job框架1自动化测试我对自动化测试架构师的定义是,不仅仅是写代码让自动化测试跑起来,而且能够超脱于工具框架的层面,对测试需求和自动化ROI一起抽......
  • 课堂笔记
     ---------------zip打包--------------'''zip函数,通过list1和list2一一对应,如果有多出的值,则忽略(自动过滤掉)举例如下:'''list1=['user','passwd','check']list2=......
  • java笔记_8_动态调用方法
    //1.根据名称获取类ClassxxxClass=Class.forName("类名");//2.根据名称获取方法//2.1.不带参数MethodxxxMethod=xxxClass.getMethod("方法......
  • J-Link使用笔记(二):J-Flash 入门
    介绍J-Flash是J-Link系列工具里用于FLASH操作的GUI工具,也支持命令行方式操作。打开软件配置工程打开后软件界面如下:为了对芯片进行烧写,需要先配置工程:根据实际使......