read-the-docs托管学习笔记

内容简介：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发布

doc

github上 push 用 sphinx-quickstart 生成的项目, build 目录可以设置到.gitignore中
登录 readthedocs ,注册账号, Connected Services 中授权 github
dashboard 中 Import a Porject 导入 github 中的项目然后 build

以上就是本文的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，也希望大家多多支持码农网

查看所有标签

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍

本书从Docker的相关概念与基础知识讲起，结合实际应用，通过不同开发环境的实战例子，详细介绍了Docker的基础知识与进阶实战的相关内容，以引领读者快速入门并提高。本书共19章，分3篇。第1篇容器技术与Docker概念，涵盖的内容有容器技术、Docker简介、安装Docker等。第2篇Docker基础知识，涵盖的内容有Docker基础、Docker镜像、Dockerfile文件、Dock......一起来看看《Docker从入门到实战》这本书的介绍吧!

码农工具