草庐IT

readthedocs

全部标签

python - 我怎样才能让 readthedocs.org build 忽略我的 requirement.txt?

我在github上有一个在Windows上运行的小应用程序项目,需要pythonnet。我的requirement.txt包含:beautifulsoup4==4.6pythonnet==2.3现在我想为它建立一个文档并将其放在readthedocs.org上。将我的文档推送到github后,将我的项目导入readthedocs.org,我尝试构建文档,但此操作失败并显示:Collectingpythonnet==2.3(from-r/home/docs/checkouts/readthedocs.org/user_builds/trelloradar/checkouts/latest

使用 gitee+sphinx+readthedocs 搭建个人博客

  给大家安利如何快速搭建个人博客网站!  前言这是我本地运行的一个使用sphinx构建的博客服务,这些文章,都是用markdown写的。一直有个想法,就是把自己写的这些文件,搞成一个博客网站,放到网上,但是,一想,要搞个域名、一个服务器,这样长期运营维护,成本有些高。再一个,个人技术博客,独立地址,百度中抓取率可能也不高,结果就是花了大成本,结果自嗨,别人搜索、访问不到,所以,一直没有行动。最近,发现用gitee+sphinx+readthedocs可以低学习成本,免资金投入,长期运营。今天,就来把这个技术分享给大家。解决方案介绍gitee,是国内免费的代码托管平台,相比github在国内,

python - 使用 Pymesh 加载和读取层文件

我正在尝试使用PyMesh和此行命令加载/读取层文件:mesh=pymesh.load_mesh("model.obj")因为它在http://pymesh.readthedocs.io/en/latest/basic.html中.但这给了我一个错误“AttributeError:‘module’对象没有属性‘load_mesh’”。我做错了什么吗?另外我想知道PyMesh是否真的允许在3d中可视化对象。谢谢。 最佳答案 如果您使用pip安装,您可能没有获得您打算使用的pymesh模块。由于您正在寻找load_mesh()方法,因此

python - Autodoc 在本地工作,但不在 ReadTheDocs 上

我使用autodoc记录了一些函数。在本地效果很好。当我提交到GitHub时,文档是建立在ReadTheDocs上的,但是没有我用“automodule”记录的功能。我在conf.py中添加了:importmockMOCK_MODULES=['numpy','scipy']formod_nameinMOCK_MODULES:sys.modules[mod_name]=mock.Mock()但这并没有帮助。这可能与我使用自己的C库有关吗?(我有我的.c文件,我编译得到.so) 最佳答案 阅读源文件和日志文件后,我收集了两件事:为什么要

python - 如何在 readthedocs 上记录 cython 函数

关于ReadTheDocs我不允许编译cython扩展,是否可以配置sphinx以便从cython文件中提取文档字符串而不实际编译它们?谢谢! 最佳答案 我遇到了同样的问题,发现现在可以在readthedocs上编译Cython扩展。简短回答:Cython模块可以使用readthedocs提供的virtualenv功能进行编译。有关稍长的答案和示例项目,请参见下文。问题是什么?据我了解,sphinx导入项目的所有模块,然后在python中提取文档字符串。这对于Cython模块是失败的,因为它们不能直接导入并且必须先编译。编译模块在r

【小沐学Python】Python实现在线电子书(MkDocs + readthedocs + github + Markdown)

文章目录1、简介2、安装3、创建新项目4、添加页面5、编辑导航页6、设置主题7、更改图标图标8、构建网站9、部署9.1准备github项目9.2注册登录ReadtheDocs9.3导入github项目到ReadtheDocs10、Markdown语法10.1横线10.2标题10.3段落10.4文字高亮10.5换行10.6斜体、粗体、删除线10.7引用10.8列表10.9代码块10.11链接10.12锚点10.13图片10.14表格10.15复选框10.16表情10.17diff语法10.18字符转义11、其他结语1、简介官网地址:https://www.mkdocs.org/MkDocs是一个

在线电子书创建:MkDocs + Github + ReadTheDocs

MkDocs是一个静态站点生成器,可用于构建项目文档。文档文件使用Markdown语法编写,本文记录如何使用MkDocs生成项目文档,并部署到ReadtheDocs上。目录安装mkdocs搭建文档项目创建项目启动项目编写文档Markdown语法站内链接图片文档结构配置文档项目项目信息更改图标主题配置部署文档到readthedocs准备github项目注册登录ReadtheDocs导入github项目到ReadtheDocs安装mkdocs先在本地搭建MkDocs站点。安装Python虚拟环境,我电脑Python环境是使用Anaconda安装的,使用conda命令创建一个虚拟环境:$condac

【小沐学Python】Python实现在线电子书(Sphinx + readthedocs + github + Markdown)

文章目录1、简介2、安装3、创建测试工程4、项目文件结构5、编译为本地文件6、编译为http服务7、更改样式主题8、支持markdown9、修改文档显示结构10、项目托管到github11、部署到ReadtheDocs结语1、简介Sphinx是一个文档生成器,您也可以把它看成一种工具,它可以将一组纯文本源文件转换成各种输出格式,并且自动生成交叉引用、索引等。也就是说,如果您的目录包含一堆reStructuredText或Markdown文档,那么Sphinx就能生成一系列HTML文件,PDF文件(通过LaTeX),手册页等。Sphinx专注于文档,尤其是handwrittendocumenta

python - 是否可以将 sphinx 预先生成的 html 文档上传到 ReadTheDocs 网站?

我有一个使用plot-directive的python-3项目。,但ReadTheDocs目前不支持此功能.因此,我想像通常使用PyPi存储库一样生成和上传文档,但使用-r选项指定不同的url。我尝试了以下方法,但失败了:$python3setup.pybuild_sphinxregisterupload_docs-rhttps://readthedocs.org/pypirunningupload_docsUsingPyPIloginfrom/home/user/.pypircUsinguploaddirectory/home/user/work/wltp.git/docs/_bui

python - 是否可以将 sphinx 预先生成的 html 文档上传到 ReadTheDocs 网站?

我有一个使用plot-directive的python-3项目。,但ReadTheDocs目前不支持此功能.因此,我想像通常使用PyPi存储库一样生成和上传文档,但使用-r选项指定不同的url。我尝试了以下方法,但失败了:$python3setup.pybuild_sphinxregisterupload_docs-rhttps://readthedocs.org/pypirunningupload_docsUsingPyPIloginfrom/home/user/.pypircUsinguploaddirectory/home/user/work/wltp.git/docs/_bui
12