程序员经验分享-hwhale

VScode+Sphinx+ReadTheDocs 从环境搭建到放弃

2023-05-16

概述

此篇博客用来记录在windows10中配置环境的过程，注意是Windows下 ，我没有在Linux下面尝试过配置。一下参考了各路教程加上自己亲测，应该是没有问题的。 ……..被掏空(◎_◎;)

目录

  • 概述
    • 目录
    • 材料清单
    • 工具安装
    • VScode配置
    • GitHub配置
    • Read The Docs 配置
    • 完成
    • 参考资料

材料清单

  • Python 3.4
  • Visual Studio Code
  • Git
  • GitHub仓库
  • GitHub Desktop

工具安装

  1. 安装Python3.4

  2. 安装Git

  3. 安装Visual Studio Code

  4. 安装GitHubDesktop

正确安装完上述软件之后接下来说明具体操作：

打开PowerShell 输入命令：

安装 sphinx

pip install sphinx sphinx-autobuild

安装 restructuredtext-lint 

pip install restructuredtext-lint

注：

To Python小白：如果没有正确的将Python添加到环境变量，那么powerShell是不会识别 pip 命令的。我也是个Python小白呵呵呵

VScode配置

  1. 安装插件 reStructuredText

这里写图片描述

它提供了.rst文件的预览功能十分便捷。

  1. 安装插件 Table Formatter

由于reStructuredText做表格特别麻烦，这个插件可以帮助你做表格，只需要把关键的标记写对，其余的都会自动补全而且效果十分美观。

Table Formatter

注意： 插件安装完成之后需要点击重新加载方能生效
这里写图片描述 To ：VSCode小白

新建Sphinx项目

  1. 新建一个目录 比如就叫：sphinxtest
  2. 在此目录下打开VSCode
  3. 打开集成终端并输入命令：
 sphinx-quickstart

过程如下：

sphinxQuickstart

sphinxQuickstart

在这么长的流程中，一般来说只有三项是需要你手动输入的，其余的均可以直接敲Enter
1. > Project name: sphinxtestProject （项目名称）
2. > Author name(s): Tom （作者）
3. > Project version []: 1.0.1 （项目版本）

注释：
1. 文档根目录(Root path for the documentation)，默认为当前目录(.)
2. 是否分离文档源代码与生成后的文档(Separate source and build directories): y
3. 模板与静态文件存放目录前缀(Name prefix for templates and static dir):_
4. 项目名称(Project name) : EvaEngine
5. 作者名称(Author name)：AlloVince
6. 项目版本(Project version) : 1.0.1
7. 文档默认扩展名(Source file suffix) : .rst
8. 默认首页文件名(Name of your master document):index
9. 是否添加epub目录(Do you want to use the epub builder):n
10. 启用autodoc|doctest|intersphinx|todo|coverage|pngmath|ifconfig|viewcode：n
11. 生成Makefile (Create Makefile)：y
12. 生成windows用命令行(Create Windows command file):y

过程执行完成

done

选择 index.rst 之后选择预览

StartPreview

效果如下：

全览

然而这个主题我个人感觉丑的不能直视

那么我们就换一个主题吧：

首先打开 Conf.py

将原本的

html_theme = 'alabaster'

换成

html_theme = 'sphinx_rtd_theme'

如图
changeTheme

接着打开终端

pip install sphinx_rtd_theme

这样就好看多了

新主题

GitHub配置

将刚才新建的 Shinxtest 文件夹 Push到GitHub仓库中，你可以单独为它建立一个仓库，也可以将它添加到你的一个项目仓库中作为项目文档。比如我就把它作为项目文档放进了我的项目仓库里。

GitHub 里选择仓库，然后依次点击 Setting => Webhooks & Service => Add service => ReadTheDocs,激活这个选项。

项目仓库

Read The Docs 配置

Read The Docs 主要是一个

  1. 进入RTD官网
  2. 注册并登陆

  3. 连接GitHub
    这里写图片描述

  4. 选择Import a project

导入项目

导入成功后，点击阅读文档，便可看到 Web 效果了。

完成

到这里算是成功啦，你可以打开VScode 在本地对 文档进行编辑。编辑完之后，由于VSCode安装了Git 所以支持将本地做的更改同步到GitHub仓库。嗯，

啊··结束！

.

参考资料

[1] http://avnpc.com/pages/writing-best-documentation-by-sphinx-github-readthedocs
写最好的文档：Sphinx + Read the Docs

[2] https://www.jianshu.com/p/78e9e1b8553a
如何用 ReadtheDocs、Sphinx 快速搭建写书环境
[3] http://www.sphinx-doc.org/en/stable/config.html
The build configuration file
[4] https://github.com/vscode-restructuredtext/vscode-restructuredtext/blob/master/docs/sphinx.md
vscode-restructuredtext/vscode-restructuredtext

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

VSCode

sphinx

ReadTheDocs

从环境搭建到放弃

VScode+Sphinx+ReadTheDocs 从环境搭建到放弃 的相关文章

  • 成功解决 vscode远程调试python

    welcome to my blog 微软新出的插件 非常方便远程调试 不需要改动代码 简单9步 配置远程调试环境 第一步 按ctrl shift x 输入remote development 安装 第二步 按ctrl shift p 输入

  • 使用vscode编辑和提交github仓库代码

    写在前面 在github上想删除仓库中的某个文件或文件夹 亦或是重命名操作都很麻烦 这里提供一种vscode的解决方案 在vscode中克隆远程github仓库 然后对代码或文件进行编辑 最后提交即可 就和管理本地文件一样方便 准备工作 下

  • Vscode连接远程服务器（一套配置成功）

    安装远程开发插件Remote Development 1 在商店中搜索Remote Development并安装 2 添加服务器连接配置 点击该选项卡 会进入SSH TARGETS的添加 如下图所示 填写配置信息可在下边操作中查看 修改 想

  • 办公小技巧：VSCode无法安装插件怎么办？

    Visual Studio Code是Microsoft开发的一款开源免费的现代化轻量级代码编辑器 它体积小 启动快 系统内存占用率低非常适合搭建IDE VSCode不仅支持几乎所有主流的开发语言的语法高亮 智能代码补全 自定义热键 括号匹

  • TensorFlow.js预测鸢尾花种类

    源码连接 TensorFlow js实现鸢尾花种类预测 机器学习文档类资源 CSDN下载 一 加载IRIS数据集 创建index html入口文件 跳转到script主文件 在script js文件夹中利用预先准备好的脚本生成鸢尾花数据集

  • VSCode『SSH』连接服务器『GUI界面』传输

    前言 最近需要使用实验室的服务器训练带有 GUI 画面的 AI 算法模型 pygame 但是我是使用 SSH 连接的 不能很好的显示模型训练的效果画面 所以下面将会讲解如何实现 SSH 连接传输 Linux GUI 画面的 注 我们没有采用

  • 阅读文档 Sphinx 版本中不包含文档字符串

    我构建了 Sphinx 文档 并且该构建在本地运行良好 我的文档字符串如下所示 当移动到 readthedoc io 时 我在下面添加了一个特定的要求文件docs requirement txt这是 sphinx 3 5 4 sphinx

  • 【最全镜像源】pip国内镜像最全收集【清华源、豆瓣、阿里云，北外，华科，中科大，中科院，腾讯云，华为云，搜狐，网易】

    清华源 i https pypi tuna tsinghua edu cn simple 北外 i https mirrors bfsu edu cn pypi web simple 中科大 i https pypi mirrors ust

  • nodejs+vue+elementui电子数码产品商城推荐系统vscode毕业设计

    基于vue的电子产品推荐系统分为前台和后台两部 前台部分主要是让用户购买和查看商品使用的 后台主要是让管理员人员发布商品相关信息和管理订单使用的 前台部分包括用户注册登录 查看商品相关信息 查看公告信息 查看热卖产品 查看精品产品 将商品加

  • 如何在制作 htmlhelp 时使用 Sphinx RTD 主题隐藏侧边栏

    使用时是否可以隐藏侧边栏Sphinx与ReadTheDocs theme 再扩展一下问题 我可以在发出命令时包含侧边栏吗 制作 html 并且不包括它发出命令 制作 htmlhelp 不改变代码 也许在layout html 中添加一些东西

  • 跨多个模型搜索多个单词

    我正在尝试在网站中创建搜索功能 并且希望用户能够搜索多个单词 根据各种模型中存在的条件执行子字符串匹配 为了这个例子 假设我有以下模型 Employee Company 市政府 County 一个县有多个市 其中有多家公司 有多名员工 我希

  • VSCode中如何查看EDI报文？

    VSCode是开发人员常用的一款软件 为了降低EDI报文的阅读门槛 知行的开发人员设计了EDI插件 可以在VSCode中下载使用 如何打开一个EDI报文 VSCode EDI插件介绍 EDI插件下载流程 进入VSCode 打开Extensi

  • VScode配置mingw C语言环境变量

    C语言IDE VScode VScode是个人比较喜欢的一款IDE软件 鄙人曾同时在VScode软件中运行三个终端 开发Python Golang和C语言 下载地址如下 code visualstudio com VScode配置mingw

  • VScode配置mingw C语言环境变量

    C语言IDE VScode VScode是个人比较喜欢的一款IDE软件 鄙人曾同时在VScode软件中运行三个终端 开发Python Golang和C语言 下载地址如下 code visualstudio com VScode配置mingw

  • Github 中的“blob”对应什么？

    下面 URL 中 blob 后面的单词指向给定存储库的 master 分支 https github com celery celery blob master docs django first steps with django rst

  • 如何在 Sphinx 运行时预处理源文件？

    我已经为我的项目设置了 Sphinx 文档 并希望提取源文件的文档字符串并将它们嵌入到最终文档中 不幸的是 Sphinx 不支持源文件的语言 VHDL VHDL 似乎没有 Sphinx 域 所以我的想法如下 挂钩 Sphinx 运行并在 S

  • Sphinx实时索引配置？

    我是 Sphinx 的新手 我需要 Linux 服务器中实时索引 sphinx config 的示例代码 对于近实时索引 您可以使用增量方法 http sphinxsearch com docs 1 10 delta updates htm

  • 如何为 reStructuredText、Sphinx、ReadTheDocs 等设置自定义样式？

    我想扩展使用的主题Sphinx and 阅读文档与我自己的自定义样式 为了让我的更改得以保留 最好的方法是什么 编辑 截至 2021 年 以下答案已过时 请使用html css files 在你的conf py而不是使用版本 1 8 之后的

  • Sphinx：警告：属性计数为 0：切换到无 docinfo

    我是 Sphinx 的新手 我似乎无法弄清楚这个警告指的是什么或如何解决它 谷歌搜索没有提供太多信息 所以我希望这里的数据库专家知道如何解决这个问题 Thanks 没有什么可害怕的 该消息表示 由于缺少这些属性 配置文件中设置的附加属性存储

  • 是否可以使用 sphinx-apidoc 在同一 git 存储库中为多个包创建文档？

    我有一个 git 存储库 其中包含多个遵循命名空间的包 即PEP 420 https www python org dev peps pep 0420 我正在尝试使用 Sphinx 创建 ReadTheDocs 文档 git 存储库看起来像

随机推荐

  • 循环冗余校验（CRC）算法入门引导

    写给嵌入式程序员的循环冗余校验 xff08 CRC xff09 算法入门引导 前言 CRC校验 xff08 循环冗余校验 xff09 是数据通讯中最常采用的校验方式 在嵌入式软件开发中 xff0c 经常要用到CRC 算法对各种数据进行校验

  • FreeRTOS 移植要点(2)

    port c port c 中主要实现了几个函数 xff1a pxPortInitialiseStack xPortStartScheduler vPortEndScheduler vPortYield vPortTickInterrupt

  • DLA （扩散限制凝聚）模型的计算机模拟

    几年前写的一个小程序 xff0c 最近找到了 程序写的比较简单 xff0c 也没做什么优化 对正在学习计算物理的同学可能会有点帮助 下面关于DLA 模型的介绍来自百度百科 Diffusion limited Aggregation xff0

  • matlab 读取处理 wav 文件

    最近工作需要 xff0c 要对wav 文件中存储的声音信息进行分析处理 所以花了些时间收集了各种数学软件中处理 wav 文件的方法 Matlab Matlab 是最方便的 甚至于不用写任何代码就能读取 wav 文件 xff08 我用的是 m

  • Savitzky-Golay 滤波器

    Savitzky Golay滤波器 xff08 通常简称为S G滤波器 xff09 最初由Savitzky 和 Golay 于 1964 年提出 xff0c 发表于Analytical Chemistry 杂志 之后被广泛地运用于数据流平滑

  • 关于查看ros中可以安装的功能包

    可以通过以下命令查看软件库中是否包含你所需要的功能包 apt cache search xxxx 其中xxx为你要搜索的关键字

  • 教你如何用原生css和html搭建一个好看的Table表格

    前言 大家在学习 lt table gt 标签的时候 xff0c 可能还没有接触css xff0c 所以你做出来的表格可能是这样的 xff1a 或者是这样的 xff1a 大家有想过自己做一个漂亮的表格吗 xff1f 我知道大家在做项目的时候

  • 如何在 Ubuntu 20.04 启用 SSH

    简介 xff1a Secure Shell SSH 是一个网络协议 xff0c 它主要被用来加密客户端和服务端之间的连接 在客户端和服务端的每一次交互都被加密 本文主要为大家讲解如何在 Ubuntu 20 04 启用 SSH 镜像下载 域名

  • 树莓派镜像SD卡烧录成功磁盘没内容解决方法

    这个情况很可能是删除分区后发生的 xff0c 只需要此电脑 管理 磁盘管理 驱动器路径 添加 确定就可以解决了

  • C++ 类学习总结(五) 继承与多态

    继承 基本概念 xff0e 基类 xff1a 可供其他类继承的类 xff0c 基类的成员也将成为派生类的成员 xff0e 派生类 xff1a 从基类继承而来的类 xff0c 称为派生类 xff0e 虚函数 xff1a 基类中希望其派生类可以

  • 行业术语 英文

    IDE 一般指集成开发的环境 如QT Creator Visual Studio等 Application framework 一般指的是应用程序框架 xff08 包含 XML xff0c GUI组件 xff0c 程序 xff0c 网络框架

  • VSCode C/C++ 格式化配置【最完整准确版本】

    一 下载Clang format 1 在VSCode插件商店下载 C C 43 43 插件 和 Clang format 插件 二 生成 clang format 文件 2 去到 C Users lt 你的用户名 gt vscode ext

  • 【时间规划】C/C++发展之路--读书

    0 xff1a 图书馆的N本C xff0c C 43 43 书 1 xff1a C语言深度解剖 2 xff1a 高质量C 43 43 c编程指南 3 xff1a C 43 43 primer第四版 4 xff1a Windows程序设计 5

  • 【Cocos2d-x】Win7+ vs2012，2010 + Cocos2d-x2.2 配置Cocos2d-X项目-环境

    新安装搭建cocos2d X的跳过这里 xff0c 看下面红色开始 xff1a cocos2d x删除vs2012项目模板 这一步新使用cocos2d x的不需要 如果你切换cocos2d x版本的话 xff0c 要将之前版本的vs模板删除

  • 【Cocos2d-x】Cocos2d-x参考案例源码解析之一：Cocos2dx各个文件说明

    这里本人电脑配置是win7 64位 xff0c cocos2d x2 20 xff0c VS2012 1 xff1a 首先当然是下载cocos2d x啦 我采用的是2 20版本 说明 xff1a 2 14以后的版本和之前的VS模板生成和环境

  • 【Cocos2d-x】Cocos2d-x参考案例源码解析之三：HelloWorld

    允许我讲些与源码无关的事情 xff01 稍后K我 由于cocos2dX3 0快出来了 xff0c 官网上说放弃objective c风格 xff0c 本屌学的是C 43 43 xff0c 所以真是太高兴了 xff0c 所以放慢的源码解析 x

  • 【Cocos2d-x】Cocos2d-x跨Android平台搭建之四：Win7 64位+ eclipse + cocos2dX

    开始研究cocos2dx xff0c mark一下这个的配置步骤 1 下载eclipse 2 下载android sdk xff0c 配置sdk路径 xff0c 添加环境变量 3 安装adt 4 下载android ndk xff0c 配置

  • 【网络通信】Wince 和 PC 通过USB 用Socket 进行通信

    网上资料比较少或者说讲的不太详细 xff0c 现在进行总结下 xff0c 刚毕业没接触过WINce xff0c 不过和MFC差不多 xff0c 现在进入正题 刚开始我的疑惑是Wince是如何和PC进行通信的 xff0c 以及能在USB模式下

  • 如何在 Ubuntu 20.04 上添加交换空间

    简介 xff1a 本文主要为大家讲解如何在 Ubuntu 20 04上添加并激活一个交换空间 镜像下载 域名解析 时间同步请点击 阿里巴巴开源镜像站 交换空间是硬盘上的一个空间 xff0c 当物理 RAM 内存被用尽时 xff0c 被紧急征

  • VScode+Sphinx+ReadTheDocs 从环境搭建到放弃

    概述 此篇博客用来记录在windows10中配置环境的过程 xff0c 注意是Windows下 xff0c 我没有在Linux下面尝试过配置 一下参考了各路教程加上自己亲测 xff0c 应该是没有问题的 被掏空 目录 概述 目录材料清单工具

热门标签