内容简介:read-the-docs托管学习笔记
Sphinx 是一个基于 Python 的文档生成项目,采用了 reStructuredText 作为文档写作语言 ,不过也可以通过模块支持其他格式.
(Sphinx标记结构)[ http://www.pythondoc.com/sphinx/markup/ ]
Sphinx安装
pip install sphinx sphinx-autobuild
快速开始
#创建目录 cd /path/to/project mkdir docs #sphinx工作目录基本配置 cd docs #可以回车按默认配置来写 sphinx-quickstart #quickstart 后生成的目录结构 readthedocs │ make.bat │ Makefile ├─build └─source │ conf.py │ index.rst ├─_static └─_templates # 默认会有一个index.rst,make html用来生成html页面 make html
添加一篇文章
在 source 目录下新建 hello.rst :
hello,world ======================================
index.rst修改如下:
Contents: .. toctree:: :maxdepth: 2 hello
make html 后效果如下:
支持markdown编写
pip install recommonmark
更改conf.py:
from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']
更改主题 sphinx_rtd_theme
pip install sphinx_rtd_theme
更改conf.py:
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
Github托管, read_the_docs发布
- github上
push用sphinx-quickstart生成的项目,build目录可以设置到.gitignore中 - 登录 readthedocs ,注册账号,
Connected Services中授权github - dashboard 中
Import a Porject导入github中的项目然后build
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
数据挖掘导论
(美)Pang-Ning Tan、Michael Steinbach、Vipin Kumar / 机械工业出版社 / 2010-9 / 59.00元
本书全面介绍了数据挖掘的理论和方法,着重介绍如何用数据挖掘知识解决各种实际问题,涉及学科领域众多,适用面广。 书中涵盖5个主题:数据、分类、关联分析、聚类和异常检测。除异常检测外,每个主题都包含两章:前面一章讲述基本概念、代表性算法和评估技术,后面一章较深入地讨论高级概念和算法。目的是使读者在透彻地理解数据挖掘基础的同时,还能了解更多重要的高级主题。 本书特色 ·包含大量的图表、......一起来看看 《数据挖掘导论》 这本书的介绍吧!