sphinx-github-readthedocs

最新推荐文章于 2023-09-28 12:14:26 发布
最新推荐文章于 2023-09-28 12:14:26 发布
阅读量832 收藏 1
点赞数 1
分类专栏： 文档管理 文章标签： sphinx readthedocs
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u012005313/article/details/85055398
版权

之前一直用CSDN编写博客，对于内容过多，那就需要多篇博客，查看起来并不方便，后来用CSDN的专栏，感觉也没有很方便

最近发现一种方式，就是用sphinx成成文档工程，用github托管代码，用readthedocs发布在线文档，这样感觉结构更加清晰，操作也比较方便

制作了第一个文档：sphinx+github+readthedocs

在这里插入图片描述

编号1993
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【CentOS-7.4】Sphinx + ReadTheDocs
qu6zhi
02-06 653
【CentOS-7.4】Sphinx + ReadTheDocs 【目标】 在不使用自己的服务器的情况下，将文章通过 Github 等代码托管平台，发布到ReadTheDocs 文档托管平台上。 ReadTheDocs 文档托管的平台，能够和常用的 GIT 阵营的 github，HG 阵营的 Bitbucket。 Github 代码托管 Sphinx 文档书写利器...
搭建在线电子书：Sphinx + Github + ReadTheDocs
测试开发小记
11-09 2436
我写博客的初衷是为了系统的构建自己的知识体系，目前使用的平台有微信公众号，CSDN，博客园，GitHub Pages和Gitee Pages，他们都各有优缺点，整理的笔记多了之后发现这些平台不是很方便，比如公众号，CSDN和博客园，每次写完文章后，还需要再平台上进行编辑再发布，比较麻烦；GitHub Pages和Gitee Pages虽然可以快速发布，但是在文章系统管理上不是很方便。我希望将笔记整理成类似电子书一样，方便搜索和管理，经过查询资料，发现了ReadTheDocs这个文档管理工具，比较符合我的需求
Sphinx+github+ReadtheDocs书写笔记
彭世瑜的博客
02-27 5289
项目很高端吧！废话不多说，直接来 搭建本地环境 1、确保电脑已经安装python运行环境 2、安装 sphinx pip install sphinx 3、新建文件夹，运行cmd 创建工程 sphinx-quickstart 按照提示填写三个信息，其他一般只用填写 1. (Separate source and build directories): y 2. 项目名...
创建Sphinx + GitHub + ReadtheDocs托管文档
田三番的博客
02-20 1051
Sphinx_GitHub_ReadtheDocs Github链接 Readthedocs链接 创建Sphinx + GitHub + ReadtheDocs托管文档 ???????????????????????????????????????????????????????????????????? Sphinx Github Readthedocs Linux配置 更换Ubuntu源 step 1: 首先看看国内有哪些源 名称 域名 ...
Sphinx + GitHub + ReadtheDocs下快速搭建你的写书平台(1)
funnyPython的博客
02-25 3037
年前的公司技术分享会上，小凡姐推荐使用ReadtheDocs、Sphinx来自动生成文档。我之前有了解过，但是一直都没去尝试一下，当时大概整理了一下，还没有发。 我想整理一下是因为我发现网上的资源其实挺少的，我主要参考简书上的一篇文章完成写书项目的搭建。 先大概介绍一下Sphinx，Github，ReadtheDocs Sphinx我在操作的时候，发现Sphinx本身，既是一个基于pytho...
pydata-sphinx-theme:来自PyData社区的基于Bootstrap的Sphinx主题
04-17
SciPy： ：//scipy.github.io/devdocs/ 散景： ： JupyterHub和粘合剂： ， http://z2jh.jupyter.org/en/latest/ ， https://repo2docker.readthedocs.io/en/latest/ ， https：//开头jupyterhub -team-compass....
Sphinx+vscode+github+readthedocs环境搭建1
08-08
登录账户是amovlab2019密码是***********登录之后可以看到有四个项目，我们与GitHub相关联的是第一个Amov-wiki进入之后点击编译，等
使用ReadTheDocs构建托管技术文档
06-16
虽然ReadTheDocs和Sphinx主要支持reST，但Typora可以作为一个良好的Markdown写作工具，通过将Markdown文件转换为reST格式，来与Sphinx和ReadTheDocs配合使用。 5. **Webhooks**: Webhooks是ReadTheDocs与其他服务...
algos-py:Python 3 中的一些 CS 算法
05-30
一路上我练习测试驱动开发（使用 ）、持续集成（使用和 ）、覆盖跟踪（使用和 ）、版本控制（使用git 、 github和gitlab ）、文档（使用sphinx和readthedocs ）和多很多。 如何测试？ 要运行所有单元测试： $ ...
sphinxext-delta:Sphinx扩展，用于预览更改的github文章
04-05
狮身人面像三角洲Sphinx扩展程序可在ReadTheDocs上生成更改文章页面。安装python -m pip install sphinxext-delta要求狮身人面像> = 2 阅读文档的GitHub 不支持其他环境。用法添加sphinxext.delta到您的扩展名列表中...
sphinx_rtd_theme, Sphinx的readthedocs.org 主题.zip
10-10
sphinx_rtd_theme, Sphinx的readthedocs.org 主题 阅读文档Sphinx主题内容阅读了文档Sphinx的主题。安装工具通过软件包通过git或者下载。配置文件项目广泛配置插件基本选项目录选项页级别配置文件变更日志文件主v0.2
使用 Sphinx 给 Python 项目生成【Read the Docs】在线文档
青笔
09-28 686
1. Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大的文档生成器，具有许多用于编写技术文档的强大功能，包括： 维护一份源文档，生成网页，可打印的PDF，用于电子阅读器（ePub）的文档等 支持 reStructuredText 或 Markdown 编写文档 被广泛使用的代码文档系统 代码示例语法高亮 活跃的官方和第三方扩展生态 1.2 Read ...
readthedocs、github 、sphinx
younghz
06-13 6436
查资料啊，查资料。
Sphinx + Github个人笔记
Tonystarky的博客
09-28 176
Sphinx是一个基于Python的文档生成项目，开始是用来生成 Python 官方文档的工具，更多介绍可参考官网：https://www.sphinx.org.cn/。
使用readthedocs+github+sphinx+reST构建文档
hello world
09-24 313
安装pip install --user sphinx sphinx-autobuild sphinx_rtd_theme read the docs sphinx使用手册 参考： 如何用 ReadtheDocs、Sphinx 快速搭建写书环境
【小沐学Python】Python实现在线电子书制作（Sphinx + readthedocs + github + Markdown）
爱看书的小沐
06-11 3003
Sphinx 是一个 文档生成器 ，您也可以把它看成一种工具，它可以将一组纯文本源文件转换成各种输出格式，并且自动生成交叉引用、索引等。也就是说，如果您的目录包含一堆 reStructuredText 或 Markdown 文档，那么 Sphinx 就能生成一系列HTML文件，PDF文件（通过LaTeX），手册页等。Sphinx 专注于文档，尤其是 handwritten documentation ，然而，Sphinx 也可以用来生成博客、主页甚至书籍。
VScode+Sphinx+ReadTheDocs 从环境搭建到放弃
大葱Blog
12-21 7161
概述此篇博客用来记录在windows10中配置环境的过程，注意是Windows下 ，我没有在Linux下面尝试过配置。一下参考了各路教程加上自己亲测，应该是没有问题的。 ……..被掏空(◎_◎;)目录概述 目录 材料清单 工具安装 VScode配置 GitHub配置 Read The Docs 配置 完成 参考资料材料清单 Python 3.4 Visual Studio Code Git Git
Windows安装Sphinx+Github+Readthedocs创建开源电子书
蛰思苑
07-06 686
Gitbook在国内无法使用，只能采用其他的平台写电子书了。 本文介绍了如何使用Sphinx创建电子书，用VS Code编辑文档，实时查看文件的网页效果，将电子书托管到Github上，并在Readthedocs平台发布。 安装各类必要工具 安装Git https://git-scm.com/download/win 安装完成后，用Windows Terminal测试 git --version 安装python https://www.python.org/downloads...
Github + Sphinx+Read the docs 实战入门指南（一）
有问题请直接说问题就好
03-18 1119
Sphinx入门指南
sphinx-build: command not found
最新发布
01-24
根据提供的引用内容，当出现"sphinx-build: command not found"错误时，可能是因为没有安装Sphinx或者没有正确设置SPHINXBUILD环境变量。以下是解决该问题的步骤： 1. 确保已经安装了Sphinx。可以使用以下命令检查...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值