Sphinx 初始化项目

Welcome to the Sphinx 1.5.6 quickstart utility.Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).Enter the root path for documentation.
> Root path for the documentation [.]:

欢迎来到Sphinx 1.5.6快速启动程序
请输入下面的提示设置(接受默认值按回车)
>选为文档择根目录[.]

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]:

你有两个选择来存放输出文件。
直接选择在根目录下建立”_build”文件夹或者分开”source”和”build”路径，
>分离source和build文件夹(y/n)[n]:

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:

在根目录下会创建模板目录”_templates”和静态文件目录”static”。你可以更改他们的前缀。
>templates和static目录文件夹的前缀[_]:

The project name will occur in several places in the built documentation.
> Project name:

输入项目的名称，这个名称会在网页中显示
>项目名称:

Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
just set both to the same value.
> Project version []:

输入版本号和发行号，一个版本号可以包含多个发行号
> 项目版本[]:
> 项目发行号[1]:

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.For a list of supported codes, see
http://sphinx-doc.org/config.html#confval-language.
> Project language [en]:

选择项目的语言
> 项目语言[en]:

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst".  Only files with this suffix are considered documents.
> Source file suffix [.rst]:

选择项目文件的后缀，只有包含该后缀的文件会被sphinx渲染
> 源文件后缀[.rst]:

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:

设置根文件，这个文件包含了”contents tree”，就是索引页
> 设置根文件[index]:

Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]:

可以为输出epub配置
> 是否使用epub输出(y/n)[n]:

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/n) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> imgmath: include math, rendered as PNG or SVG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]:
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]:

是否使用一下的拓展：
> autodoc:自动为模块生成文档(y/n) [n]:
> doctest:
> intersphinx:
> todo
> coverage
> imgmath
> mathjax
> ifconfig
> viewcode
> githubpages

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (y/n) [y]:
> Create Windows command file? (y/n) [y]:

是否创建makefile，来使用make html替代sphinx-build
> 创建makefile(y/n) [y]:
> 创建win 命令行文件? (y/n) [y]:

完成之后会生成如下模板

.
├── build # 输出文档
├── make.bat # win下的生成命令
├── Makefile # linux下的生成命令
└── source├── conf.py # 生成的配置├── index.rst # 索引文件├── _static # 静态文件└── _templates # 模板文件

Sphinx 初始化项目相关推荐

Vue 脚手架CLI 初始化项目
1 介绍 CLI是Command-Line Interface,翻译为命令行界面,但是俗称脚手架. Vue CLI是一个官方发布vue.js项目脚手架使用vue-cli可以快速搭建vue开发环境以及 ...
利用node、express初始化项目
前端做整站是开发,例如:前端是用了vue创建初始化项目,后端我们不会php.java等,我们只能用node去创建去做后端代码,本文就给大家讲解最基础的从零开始创建一个项目的后端环境. 一般来说前后端代 ...
Vue.js-Day06-AM【项目实战(附带完整项目源码)-day01-am：移动端响应式（响应式尺寸、视口问题、实现rem变化、rem设计）、实战项目搭建（初始化项目、处理rem、搭建路由）】
Vue.js实训[基础理论(5天)+项目实战(5天)]博客汇总表[详细笔记] 实战项目源码[链接:https://pan.baidu.com/s/1r0Mje3Xnh8x4F1HyG4aQTA 提 ...
react native初始化项目
打开命令行窗口,进入我们想要创建项目的父目录,输入命令: react-native init 项目名进入新建的项目目录,执行升级命令: cd 项目名 react-native upgrade 提示: ...
vue 环境的搭建及初始化项目
其实超级简单,虽然网上很多,但是我顺便记录下相当于做笔记吧 1nodejs 的安装, 在node官网下载,点击安装,安装的时候最好选择路径在d盘 2设置环境变量我的电脑-->属性-->系 ...
七、Vue cli详解学习笔记——什么是Vue cli ,Vue cli的使用（安装，拉取2.x模板，初始化项目），Vue cli2详解，Runtime-Compiler和Runtime-only区别
一.什么是Vue CLI 如果你只是简单写几个Vue的Demo程序, 那么你不需要Vue CLI. 如果你在开发大型项目, 那么你需要, 并且必然需要使用Vue CLI 使用Vue.js开发大型应用时 ...
Vue.js之使用vue-cli初始化项目
一.安装步骤 step1.安装Node.js 首先需要下载并安装Node.js,下载地址:Node官网. 可查看我的另外一篇文章,仅作参考:Node.js入门及安装测试安装是否成功,打开cmd,使用 ...
IntelliJ IDEA 初始化项目时No Java SDK Found
IntelliJ IDEA 初始化项目时No Java SDK Found 自己在Project SDK后面的New按钮进行JDK的添加: 转载于:https://www.cnblogs.com/st ...
SpringBoot→初始化项目just run@SpringBootApplication、请求处理@RequestMapping、属性配置yml
官网 https://spring.io/ 官网初始化项目 IDEA初始化项目 pom.xml MAVEN初始化项目 @controller+@ResponseBody=功能等效于=@RestCont ...

Sphinx 初始化项目

Sphinx 初始化项目相关推荐

最新文章

热门文章