Mercurial > evolve
annotate docs/conf.py @ 2402:d7230f7162b7
test: adapt to change in cache warming in core
Core Mercurial has a more rational cache warming strategy now. 24f55686a63d
stopped warming of the cache after every changegroup application (in favor of
end of transaction warming). This reflect in the blackbox test output.
author | Pierre-Yves David <pierre-yves.david@octobus.net> |
---|---|
date | Wed, 17 May 2017 18:54:48 +0200 |
parents | fc6183051112 |
children | 1b4c92621e23 |
rev | line source |
---|---|
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
1 # Add any Sphinx extension module names here, as strings. They can be extensions |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
2 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
3 extensions = [] |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
4 # autoclass_content = 'both' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
5 # Add any paths that contain templates here, relative to this directory. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
6 # templates_path = [] |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
7 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
8 # The suffix of source filenames. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
9 source_suffix = '.rst' |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
10 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
11 # The master toctree document. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
12 master_doc = 'index' |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
13 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
14 # General substitutions. |
981
34e4e51affd1
docs: update copyright statement used by sphinx
Greg Ward <greg@gerg.ca>
parents:
766
diff
changeset
|
15 project = 'evolve extension for Mercurial' |
34e4e51affd1
docs: update copyright statement used by sphinx
Greg Ward <greg@gerg.ca>
parents:
766
diff
changeset
|
16 copyright = '2010-2014, Pierre-Yves David, Greg Ward, and contributors' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
17 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
18 # The default replacements for |version| and |release|, also used in various |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
19 # other places throughout the built documents. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
20 # |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
21 # The short X.Y version. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
22 version = '0.0' |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
23 # The full version, including alpha/beta/rc tags. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
24 release = '0.0' |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
25 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
26 # There are two options for replacing |today|: either, you set today to some |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
27 # non-false value, then it is used: |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
28 # today = '' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
29 # Else, today_fmt is used as the format for a strftime call. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
30 today_fmt = '%B %d, %Y' |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
31 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
32 # List of documents that shouldn't be included in the build. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
33 unused_docs = [] |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
34 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
35 # List of directories, relative to source directories, that shouldn't be searched |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
36 # for source files. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
37 # exclude_dirs = [] |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
38 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
39 # The reST default role (used for this markup: `text`) to use for all documents. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
40 # default_role = None |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
41 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
42 # If true, '()' will be appended to :func: etc. cross-reference text. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
43 # add_function_parentheses = True |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
44 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
45 # If true, the current module name will be prepended to all description |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
46 # unit titles (such as .. function::). |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
47 # add_module_names = True |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
48 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
49 # If true, sectionauthor and moduleauthor directives will be shown in the |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
50 # output. They are ignored by default. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
51 # show_authors = False |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
52 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
53 # The name of the Pygments (syntax highlighting) style to use. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
54 pygments_style = 'sphinx' |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
55 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
56 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
57 # Options for HTML output |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
58 # ----------------------- |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
59 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
60 # The style sheet to use for HTML and HTML Help pages. A file of that name |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
61 # must exist either in Sphinx' static/ path, or in one of the custom paths |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
62 # given in html_static_path. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
63 # html_style = 'sphinx-default.css' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
64 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
65 # The name for this set of Sphinx documents. If None, it defaults to |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
66 # "<project> v<release> documentation". |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
67 html_title = project |
166
8f8a52cd0b9f
big doc update
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
161
diff
changeset
|
68 html_theme = 'haiku' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
69 html_theme_path = ['.'] |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
70 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
71 # A shorter title for the navigation bar. Default is the same as html_title. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
72 # html_short_title = None |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
73 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
74 # The name of an image file (within the static path) to place at the top of |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
75 # the sidebar. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
76 # html_logo = 'logo-evolve.svg' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
77 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
78 # The name of an image file (within the static path) to use as favicon of the |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
79 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
80 # pixels large. |
557
41688ca951e7
doc: add a logo
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
166
diff
changeset
|
81 html_favicon = 'logo-evolve.ico' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
82 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
83 # Add any paths that contain custom static files (such as style sheets) here, |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
84 # relative to this directory. They are copied after the builtin static files, |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
85 # so a file named "default.css" will overwrite the builtin "default.css". |
557
41688ca951e7
doc: add a logo
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
166
diff
changeset
|
86 html_static_path = ['static'] |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
87 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
88 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
89 # using the given strftime format. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
90 html_last_updated_fmt = '%b %d, %Y' |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
91 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
92 # If true, SmartyPants will be used to convert quotes and dashes to |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
93 # typographically correct entities. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
94 # html_use_smartypants = True |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
95 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
96 # Custom sidebar templates, maps document names to template names. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
97 # html_sidebars = {} |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
98 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
99 # Additional templates that should be rendered to pages, maps page names to |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
100 # template names. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
101 # html_additional_pages = {} |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
102 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
103 # If false, no module index is generated. |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
104 html_use_modindex = False |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
105 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
106 # If false, no index is generated. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
107 # html_use_index = True |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
108 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
109 # If true, the index is split into individual pages for each letter. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
110 # html_split_index = False |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
111 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
112 # If true, the reST sources are included in the HTML build as _sources/<name>. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
113 # html_copy_source = True |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
114 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
115 # If true, an OpenSearch description file will be output, and all pages will |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
116 # contain a <link> tag referring to it. The value of this option must be the |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
117 # base URL from which the finished HTML is served. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
118 # html_use_opensearch = '' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
119 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
120 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
121 # html_file_suffix = '.html' |
161
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
122 |
4e3f25ba5401
More doc and index with sphynx
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
diff
changeset
|
123 # Output file base name for HTML help builder. |
2034
fc6183051112
flake8: remove "error" in documentation configuration
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents:
981
diff
changeset
|
124 # htmlhelp_basename = '' |