最前端

我的工作,我的生活,点点滴滴...

标签 ‘ python

安装sphinx

  1. 安装python 2.7.5
  2. 安装easy_install
  3. 3.通过essy_install安装sphinx注意:http://sourceforge.net/有可能被墙而无法安装成功,翻墙后再安装

  4. 按照sphinx-quickstart引导生成文档项目结构
  5. 进入文档项目目录make html生成html页面
G:\sphinx>sphinx-quickstart
Welcome to the Sphinx 1.2b1 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 [.]: bq69_posts
 
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]: y
 
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 [_]:
 
The project name will occur in several places in the built documentation.
> Project name: Bq69 Posts
> Author name(s): Chance Dai
 
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.0.0
> Project release [1.0.0]: 1.0.0
 
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]:
 
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]:
 
Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/N) [n]: y
 
Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/N) [n]:
> doctest: automatically test code snippets in doctest blocks (y/N) [n]: y
> 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]: y
> coverage: checks for documentation coverage (y/N) [n]:
> pngmath: include math, rendered as PNG 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]: y
 
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]:
 
Creating file bq69_posts\source\conf.py.
Creating file bq69_posts\source\index.rst.
Creating file bq69_posts\Makefile.
Creating file bq69_posts\make.bat.
 
Finished: An initial directory structure has been created.
 
You should now populate your master file bq69_posts\source\index.rst and create
other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.
 
 
 
G:\sphinx>cd bq69_posts
 
G:\sphinx\bq69_posts>make html
Making output directory...
Running Sphinx v1.2b1
loading pickled environment... not yet created
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index
 
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
 
writing additional files... (0 module code pages) genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded.
 
Build finished. The HTML pages are in build/html.
 
G:\sphinx\bq69_posts>tree /
 
│  make.bat
│  Makefile
│
├─build
│  ├─doctrees
│  │      environment.pickle
│  │      index.doctree
│  │
│  └─html
│      │  .buildinfo
│      │  genindex.html
│      │  index.html
│      │  objects.inv
│      │  search.html
│      │  searchindex.js
│      │
│      ├─_sources
│      │      index.txt
│      │
│      └─_static
|			css,js,png等静态资源
│
└─source
    │  conf.py
    │  index.rst
    │
    ├─_static
    └─_templates