索引 - Sphinx官方指南 - PHPERZ中文资讯站

发布于 2015-09-16 15:49:44 | 182 次阅读 | 评论: 0 | 来源: 网络整理

Symbols | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W

Symbols

$.getJSON() ($ method)

-a

sphinx-build command line option

-A author

sphinx-apidoc command line option

-A name=value

sphinx-build command line option

-b 生成器名字

sphinx-build command line option

-C

sphinx-build command line option

-c 路径

sphinx-build command line option

-d maxdepth

sphinx-apidoc command line option

-D setting=value

sphinx-build command line option

-d 路径

sphinx-build command line option

-E

sphinx-build command line option

-f, --force

sphinx-apidoc command line option

-F, --full

sphinx-apidoc command line option

-H project

sphinx-apidoc command line option

-N

sphinx-build command line option

-n

sphinx-build command line option

-n, --dry-run

sphinx-apidoc command line option

-o outputdir

sphinx-apidoc command line option

-P

sphinx-build command line option

-Q

sphinx-build command line option

-q

sphinx-build command line option

-R release

sphinx-apidoc command line option

-s suffix

sphinx-apidoc command line option

-t tag

sphinx-build command line option

-T, --no-toc

sphinx-apidoc command line option

-V version

sphinx-apidoc command line option

-W

sphinx-build command line option

-w file

sphinx-build command line option

A

abbr (role)
add_autodoc_attrgetter() (sphinx.application.Sphinx method)
add_autodocumenter() (sphinx.application.Sphinx method)
add_builder() (sphinx.application.Sphinx method)
add_config_value() (sphinx.application.Sphinx method)
add_crossref_type() (sphinx.application.Sphinx method)
add_directive() (sphinx.application.Sphinx method)
add_directive_to_domain() (sphinx.application.Sphinx method)
add_domain() (sphinx.application.Sphinx method)
add_event() (sphinx.application.Sphinx method)
add_generic_role() (sphinx.application.Sphinx method)
add_index_to_domain() (sphinx.application.Sphinx method)
add_javascript() (sphinx.application.Sphinx method)
add_lexer() (sphinx.application.Sphinx method)
add_node() (sphinx.application.Sphinx method)
add_object_type() (sphinx.application.Sphinx method)

add_role() (sphinx.application.Sphinx method)

add_role_to_domain() (sphinx.application.Sphinx method)

add_search_language() (sphinx.application.Sphinx method)

add_stylesheet() (sphinx.application.Sphinx method)

add_transform() (sphinx.application.Sphinx method)

array<T>::operator[] (C++ function)

attributes (built-in variable)

autoattribute (directive)

autoclass (directive)

autodata (directive)

autoexception (directive)

autofunction (directive)

automatic

documentation
linking
testing

automethod (directive)

automodule (directive)

autosummary (directive)

B

bar (directive)
BaseSearch (class in sphinx.websupport.search)

builder

(built-in variable)

Builder (class in sphinx.builders)

C

c:data (role)

c:func (role)

c:function (directive)

c:macro (directive)

(role)

c:member (directive)

c:type (directive)

(role)

c:var (directive)

centered (directive)

changes

in version

ChangesBuilder (class in sphinx.builders.changes)

CheckExternalLinksBuilder (class in sphinx.builders.linkcheck)

class (built-in variable)

classes (built-in variable)

code

examples

codeauthor (directive)

command (role)

conf (module)

configuration directory

connect() (sphinx.application.Sphinx method)

contents

table of

copyright (built-in variable)

CoverageBuilder (class in sphinx.ext.coverage)

cpp:class (directive)

(role)

cpp:func (role)

cpp:function (directive)

cpp:member (directive)

(role)

cpp:namespace (directive)

cpp:type (directive)

(role)

css_files (built-in variable)

D

default-domain (directive)
deprecated (directive)
describe (directive)
DevhelpBuilder (class in sphinx.builders.devhelp)
dfn (role)
digraph (directive)
directive
DirectoryHTMLBuilder (class in sphinx.builders.html)
disconnect() (sphinx.application.Sphinx method)

doc (role)

docstitle (built-in variable)

docstring

doctest

(directive)

document name

documentation

automatic

domain

download (role)

E

embedded (built-in variable)

emit() (sphinx.application.Sphinx method)

emit_firstresult() (sphinx.application.Sphinx method)

enumerate() (built-in function)

environment

envvar (directive)

(role)

EpubBuilder (class in sphinx.builders.epub)

eq (role)

examples

code

exceptions (built-in variable)

ExtensionError

F

favicon (built-in variable)
file (role)
file_suffix (built-in variable)

foo (C++ function)

(directive)
(role)

fullname (built-in variable)

functions (built-in variable)

G

globalcontext_filename (sphinx.builders.html.SerializingHTMLBuilder attribute)
glossary (directive)
graph (directive)

graphviz (directive)
guilabel (role)

H

has_source (built-in variable)
hasdoc() (built-in function)

hlist (directive)
HTMLHelpBuilder (class in sphinx.builders.htmlhelp)

I

ifconfig (directive)

implementation (sphinx.builders.html.SerializingHTMLBuilder attribute)

in version

changes

index (directive)

(role)

inheritance-diagram (directive)

J

js:attr (role)

js:attribute (directive)

js:class (directive)

(role)

js:data (directive)

(role)

js:func (role)
js:function (directive)
JSONHTMLBuilder (class in sphinx.builders.html)

K

kbd (role)

keyword (role)

L

last_updated (built-in variable)

LaTeXBuilder (class in sphinx.builders.latex)

linking

automatic

literalinclude (directive)
logo (built-in variable)

M

mailheader (role)

makevar (role)

manpage (role)

ManualPageBuilder (class in sphinx.builders.manpage)

master document

master_doc (built-in variable)

math (directive)

(role)

members (built-in variable)

menuselection (role)
MessageCatalogBuilder (class in sphinx.builders.gettext)
meta (built-in variable)
methods (built-in variable)
mimetype (role)
module (built-in variable)
MyAnimal() (class)

N

name (built-in variable)
namespaced::theclass::method (C++ function), [1]
newsgroup (role)

next (built-in variable)

note

(directive)

O

object

(directive)

objname (built-in variable)

only (directive)

operator bool (C++ function)

option (directive)

(role)

out_suffix (sphinx.builders.html.SerializingHTMLBuilder attribute)

override_domain() (sphinx.application.Sphinx method)

P

pagename (built-in variable)

parents (built-in variable)

pathto() (built-in function), [1]

pep (role)

PickleHTMLBuilder (class in sphinx.builders.html)

prev (built-in variable)

productionlist (directive)

program (directive)

(role)

project (built-in variable)

py:attr (role)

py:attribute (directive)

py:class (directive)

(role)

py:classmethod (directive)

py:const (role)

py:currentmodule (directive)

py:data (directive)

(role)

py:decorator (directive)

py:decoratormethod (directive)

py:exc (role)

py:exception (directive)

py:func (role)

py:function (directive)

py:meth (role)

py:method (directive)

py:mod (role)

py:module (directive)

py:obj (role)

py:staticmethod (directive)

Q

QtHelpBuilder (class in sphinx.builders.qthelp)

R

ref (role)
regexp (role)
relbar() (built-in function)
reldelim1 (built-in variable)
reldelim2 (built-in variable)
release (built-in variable)
rellinks (built-in variable)

require_sphinx() (sphinx.application.Sphinx method)

rfc (role)

role

rst:dir (role)

rst:directive (directive)

rst:role (directive)

(role)

rubric (directive)

S

samp (role)

script_files (built-in variable)

searchindex_filename (sphinx.builders.html.SerializingHTMLBuilder attribute)

sectionauthor (directive)

seealso (directive)

SerializingHTMLBuilder (class in sphinx.builders.html)

setup_extension() (sphinx.application.Sphinx method)

shorttitle (built-in variable)

show_source (built-in variable)

sidebar() (built-in function)

SingleFileHTMLBuilder (class in sphinx.builders.html)

snippets

testing

source directory

sourcecode

sourcename (built-in variable)

sphinx-apidoc command line option

-A author
-F, --full
-H project
-R release
-T, --no-toc
-V version
-d maxdepth
-f, --force
-n, --dry-run
-o outputdir
-s suffix

sphinx-build command line option

-A name=value
-C
-D setting=value
-E
-N
-P
-Q
-W
-a
-b 生成器名字
-c 路径
-d 路径
-n
-q
-t tag
-w file

sphinx.application (module)

sphinx.builders (module)

sphinx.builders.changes (module)

sphinx.builders.devhelp (module)

sphinx.builders.epub (module)

sphinx.builders.gettext (module)

sphinx.builders.html (module)

sphinx.builders.htmlhelp (module)

sphinx.builders.latex (module)

sphinx.builders.linkcheck (module)

sphinx.builders.manpage (module)
sphinx.builders.qthelp (module)
sphinx.builders.texinfo (module)
sphinx.builders.text (module)
sphinx.domains (module)
sphinx.ext.autodoc (module)
sphinx.ext.autosummary (module)
sphinx.ext.coverage (module)
sphinx.ext.doctest (module)
sphinx.ext.extlinks (module)
sphinx.ext.graphviz (module)
sphinx.ext.ifconfig (module)
sphinx.ext.inheritance_diagram (module)
sphinx.ext.intersphinx (module)
sphinx.ext.jsmath (module)
sphinx.ext.mathbase (module)
sphinx.ext.mathjax (module)
sphinx.ext.oldcmarkup (module)
sphinx.ext.pngmath (module)
sphinx.ext.refcounting (module)
sphinx.ext.todo (module)
sphinx.ext.viewcode (module)
sphinx_version (built-in variable)
StandaloneHTMLBuilder (class in sphinx.builders.html)
StorageBackend (class in sphinx.websupport.storage)
style (built-in variable)

T

U

underline (built-in variable)

use_opensearch (built-in variable)

V

version (built-in variable)
versionadded (directive)

versionchanged (directive)

W

warning

(directive)

WebSupport (class in sphinx.websupport)

索引

Symbols

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

后端技术

前端技术

数据库

热门框架

常用IDE

其他