http://daler.github.io/sphinxdoc-test/includeme.html http://pages.github.com/ http://www.lulinfeng.com/sphinx-github.html http://hi.baidu.com/limodou/item/bffbe725413abd0977272cf6…

最新博客链接 "Tsanfer's Blog" 创建Sphinx + GitHub + ReadtheDocs托管文档 Readthedocs在线电子书链接…

1.安装git,TortoiseGit. 2.用帐号A登陆github,建立一个版本仓库test1.用默认值创建就可以了. 3.在本机用TortoiseGit克隆仓库test1.直接选https开头的网址就可以了,不用登陆不用验证就可以克隆下来.缺点就是速度会比较慢,而且每次本地修改完要推送的时候需要输入帐号和密码,非常麻烦. 4.如果本机修改了文件要提交的话就会提示你要输入帐号密码,帐号就是帐号A.如果输入帐号B的登陆信息会提交失败.因为帐号B没有权限提交修改到帐号A的仓库里. 5.如果在gi…

Readthedocs支持Markdown格式和sphinx格式的文档排版,是部署项目文档的绝佳平台.利用Github的托管服务,我们可以方便地将文档托管于Github,并利用Readthedocs查阅. 1. 在Readthedocs上新建一个项目,在项目中的:管理 -> Integrations -> 添加Github incoming webhook,记下webhook链接地址,待会儿要用: 2. 在Github上新建一个项目,在项目中的:Setting -> Webhooks中添…

ReadtheDocs Read the Docs非常适合写软件文档以及编写一些教程.电子书之类.对于一些一两篇文章就能写清楚的可以记笔记或写博客, 但是如果要写成一个系列的,不如写成一本书的形式,更美观,也更系统. Read the Docs是一个在线文档托管系统, 你可以从各种版本控制系统中导入文档,如果你使用webhooks, 那么每次提交代码后可以自动构建并上传至readthedocs网站,非常方便. 现有的写电子书的方式,有以下几个解决方案,优劣势也很明显: 写博客,跟散文堆在一起,不…

自建扩展介绍 Flask扩展分两类 纯功能, 如: Flask-Login 提供用户认证 对已有的库和工具包装(简化继承操作,并提供有用的功能,更方便) 如: Flask-SQLAlchemy 包装了 SQLAlchemy 涉及的 python 包 setuptools : wheel : twine: 发布python 包 (发布到 PyPI 后才能使用 pip 或 pipenv 安装) readme_renderer: 将 md.rst.txt 文本 渲染成.html 命名: 扩展的名称:…

FISCO BCOS是完全开源的联盟区块链底层技术平台,由金融区块链合作联盟(深圳)(简称金链盟)成立开源工作组通力打造.开源工作组成员包括博彦科技.华为.深证通.神州数码.四方精创.腾讯.微众银行.亦笔科技和越秀金科等金链盟成员机构. 2019年6月18日,FISCO BCOS v2.0.0-rc3正式发布,该版本对底层平台的易用性.性能等方面进行了多项优化. 最新代码和技术文档已在github和readthedocs上同步更新,欢迎体验和star支持. 代码仓库: https://githu…

iOS完整App资源收集 <iOS完整app资源收集>  <GitHub 上有哪些完整的 iOS-App 源码值得参考?> <GitHub 上有哪些完整的 iOS-App 源码值得参考?> 摘自github上# TimLiu-iOS的文章======== 自己总结的iOS.mac开源项目及库,持续更新.... github排名 [https://github.com/trending](https://github.com/trending),github搜索:[htt…

这里是总结了一下,用的工具或者平台:readthedocs.github .sphinx. 使用这三个工具即可轻松创建高效的文档管理库,可以用来翻译,水平再高一点可以写书. readthedocs 文档托管的平台,能够和常用的GIT阵营的github,HG阵营的Bitbucket,关于这两个平台的讨论比较文章可以参考. github 代码托管 sphinx 文档书写利器,使用的是reStructuredText格式,reStructuredText简明教程. 下面说说书写方法及托管流程 在这里注…

此sphinx可不是彼sphinx,此篇是指生成文档的工具,是python下最流行的文档生成工具,python官方文档即是它生成,官方网站是http://www.sphinx-doc.org,这里是一个中文翻译站:https://zh-sphinx-doc.readthedocs.io readthedocs.org(下文简称rtd)是一个基于sphinx.mkdocs的在线文档托管网站,支持git.subversion等版本控制系统,并提供多版本.翻译.下载文档等,颇受欢迎. 此篇文章记录了本…

readthedocs 是由社区驱动的开源sphinx doc 托管服务,我们可以用来方便的构建以及发布文档 这是一个简单的demo 项目,使用了用的比较多的sphinx_rtd_theme 主题,主要是试用 注册账户 sphinx 文档需要让readthedocs 托管,我们需要一个账户,注册地址 https://readthedocs.org/ ,注册很简单,我们同时需要进行邮件验证 简单demo 项目 我们可以使用sphinx-quickstart 帮助我们生成简单的测试doc sphin…

1 git安装请参见廖雪松的git教程前面几节 点击前往 2 git速成之基本命令 点击前往 3 git 和 GitHub 配合使用之基础 点击前往 4 git 和 GitHub 配合使用之进阶 点击前往 5 git详解 点击前往 6 git 和 码云 配合使用 点击前往 7 git 和 eclipse 配合使用 点击前往…

一.文档撰写前提 环境部署: > git clone https://github.com/toooney/demo-readthedocs.git > pip install sphinx recommonmark sphinx-autobuild sphinx_rtd_theme -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host=mirrors.aliyun.com 二.撰写博文并发表 把你要发表的博文放在 demo-read…

Git教程 http://www.liaoxuefeng.com/wiki/0013739516305929606dd18361248578c67b8067c8c017b000 Git 本地仓库详解 http://www.linuxidc.com/Linux/2014-09/106234.htm Git Shell cmd使用笔记 http://stone.leanote.com/post/GitShellcmd%E4%BD%BF%E7%94%A8%E7%AC%94%E8%AE%B0 GitHu…

git和Github 概念 git --- 版本控制工具(命令). 工具介绍官方网站:http://git-scm.com 工具下载地址:http://git-scm.com/download/ git是一个开源的分布式版本控制系统,用以有效.高速的处理从很小到非常大的项目版本管理.git是个工具,在linux里面也就类似gcc这样的工具一样,是一个shell命令.git是Linus Torvalds为了帮助管理Linux内核开发而开发的一个开放源码的版本控制软件.Torvalds开始着手开发g…

1 spinx简介 Sphinx 是一种文档工具,它可以令人轻松的撰写出清晰且优美的文档, 由 Georg Brandl 在BSD 许可证下开发. 新版的Python文档 就是由Sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对 C/C++ 项目也有很好的支持; 并计划对其它开发语言添加特殊支持. 本站当然也是使用 Sphinx 生成的,它采用reStructuredText! Sphinx还在继续开发. 下面列出了其良好特性,这些特性在Python官方文档中均有体现: 丰…

0 前言 写文档是开发人员日常工作中的一项重要内容,除了word之外,我更偏爱使用标记语言(Markup Language).使用标记语言,可以利用简单.免费的文本编辑器(记事本,vim, emacs...)编写文档并设置格式,再生成html或pdf等格式,或者直接把编辑好的文件传到github或wiki上面 ,通过浏览器可以直接查看带有格式的文档. 目前标记语言主要有两种,Markdown和reStructuredText(简称reST).该使用哪一种是一个见仁见智的选择,我在这里就不比较它们…

文档生成工具: 自带的pydoc,比较差 建议使用sphinx 安装: pip install sphinx 安装主题: 由各种主题,我选择常用的sphinx_rtd_theme pip install sphinx_rtd_theme 使用方法: 1.创建文件夹doc:mkdir doc:cd doc:执行sphinx-quickstart,进入引导,根据需要选择yes或者no 2.执行sphinx-quickstart引导程序只会生成一个index.rst 3.在doc目录下执行sphinx…

之前有不少同学看过我的个人博客(http://python-online.cn),也根据我写的教程完成了自己个人站点的搭建. 点此:使用 Python 30分钟 教你快速搭建一个博客 为防有的同学不清楚 Sphinx ,这里还是做下简单的介绍. 它是一个能够把一组 reStructuredText 或者 Markdown 格式的文件转换成各种输出格式,而且自动地生成交叉引用,生成目录等的一个文档编排工具. 不得不说,它的排版功能强大.非常清晰,顔值非常高. 但是使用这个方法搭建的博客,一直有一个…

Sphinx https://www.sphinx.org.cn/ Sphinx是一个工具,可以轻松创建由Georg Brandl编写并根据BSD许可证授权的智能和美观文档 它最初是为Python文档创建的,它具有出色的工具,可用于各种语言的软件项目文档. 当然,这个站点也是使用reStructuredText源创建的 输出格式: HTML(包括Windows HTML帮助),LaTeX(适用于可打印的PDF版本),ePub,Texinfo,手册页,纯文本 广泛的交叉引用: 语义标记和功能,类,…

sphinx 在python 语言开发中,是一个使用的比较多文档生成脚手架工具,我们帮助我们生成 专业的帮助文档,同时也有远端的免费saas 托管服务,方便分发 安装 sphinx 的安装好多方便,mac 的可以使用brew,或者我们可以使用pip 安装,详细的可以参考官方文档 mac brew 安装方法   brew install sphinx-doc pip 安装 pip install -U sphinx 简单demo sphinx 提供了一个快速生成文档的命令,使用sphinx-qui…

前言: 使用Sphinx 生成文档和使用 Read The Docs 的 readthedocs/sphinx_rtd_theme,假设是在Windows上运行并已安装好 python,可以执行python的 pip命令 通过 pip命令安装 sphinx 和 sphinx_rtd_theme pip install -U Sphinx pip install sphinx-rtd-theme 在一个系统中的一个空的文件夹中运行: 如我在D 盘中新建了一个名字为 sphinx的文件夹 sphin…

gitbook生成的html目录不折叠且链接失效 装好了gitbook和nodejs,本以为可以安心的做电子书了. 谁想到gitbook慢的一P,而且导出来的html目录不折叠,最关键的是链接有问题,用不了,无语. 目录折叠可以用一个插件toggle-chapters.或者用这个作者的方法. 而链接用不了,很少有记录有人处理过这个问题.这里有一个可以用,但是要每次都处理,而且他的目录居然是每次点击都要刷新加载,太慢了,不符合潮流啊 .https://blog.csdn.net/yageeart/…

依赖管理 ——用于依赖管理的包和框架 Composer/Packagist : 一个包和依赖管理器 Composer Installers:  一个多框架Composer库安装器 Pickle: 可以在任意平台上安装PHP扩展包 依赖管理的附加部分 ——其它依赖管理的相关工具 Satis : 静态的Composer库生成器 Composition: 一个运行时检查Composer环境的库 Version : 一个在语义上分析和比较的库 NameSpacer : 将下划线转为命名空间的库 Patc…

Java资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列的资源整理.awesome-java 就是 akullpp 发起维护的 Java 资源列表,内容包括:构建工具.数据库.框架.模板.安全.代码分析.日志.第三方库.书籍.Java 站点等等.伯乐在线已经把 awesome-java 资源列表翻成中文后发布于 ImportNew. Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的介绍,如果有更详细的中文介绍,对相应开发者的帮助会更…

转自:http://github.tiankonguse.com/blog/2014/12/03/sphinx-token-inverted-sort.html 外部排序 现在我们的背景是有16个已经排序的数据存在磁盘上.由于数据量很大,我们不能一次性全部读进来. 我们的目标是依次挑出最小的hit,然后交给索引引擎处理. sphinx 使用了 CSphHitQueue 这个数据结构. CSphHitQueue 你猜是什么? 队列? 恭喜你,猜错了.CSphHitQueue 是一个最小堆.且堆的最…

不多废话,测试环境 `ubuntu 13.10` ## 安装 sudo apt-get install sphinxsearch ## 配置 nano /etc/sphinxsearch/sphinx.conf # 数据源配置 source default { type = xmlpipe2 xmlpipe_command = /path/xmlpipe2 xmlpipe_fixup_utf8 = 1 } # 索引配置 index default { type = plain source =…

Github上PHP资源汇总大全,php学习的好资料 国外程序员ziadoz 在Github上收集整理了PHP的各种资源,内容包括模板.框架.数据库.安全等方面的库和工具.汇总了各种PHP资源,供各位PHP学习者和程序员参考.英文原文:https://github.com/ziadoz/awesome-php 依赖管理 ——用于依赖管理的包和框架Composer/Packagist : 一个包和依赖管理器Composer Installers:  一个多框架Composer库安装器Pickle:…

由于本人比较懒,所以一般都是用xampp的直接拿来改的…………(当然xampp中一般php版本都是比较新的用的过程中请大家注意哈,可能会和老版本冲突) 此次除了使用xampp外,还扩展了sphinx,redis,sqlserver在linux中的配置等   #基础安装 apt-get install ssh apt-get install vim apt-get install subversion apt-get install git-core apt-get install curl ap…

示例的Python源代码或者交互界面都可以使用标准reST模块实现.在正常段落后面跟着 :: 开始,再加上适当缩进. 交互界面需包含提示及Python代码的输出. 交互界面没有特别的标记. 在最后一行输入或输出之后,不应出现空的提示; 这是一个什么都不做的例子: >>> 1 + 1 2 >>> 语法高亮显示由 Pygments (如果安装) 优雅的显示: 每个源文件都有高亮语言”highlighting language”. 默认是 'python' ,多数文件会高亮显…