|
13 | 13 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
14 | 14 | import os |
15 | 15 | import sys |
16 | | -sys.path.insert(0, os.path.abspath('..')) |
| 16 | + |
| 17 | +sys.path.insert(0, os.path.abspath("..")) |
17 | 18 |
|
18 | 19 | # import art |
19 | 20 |
|
20 | 21 | # -- Project information ----------------------------------------------------- |
21 | 22 |
|
22 | | -project = 'Adversarial Robustness Toolbox' |
23 | | -copyright = '2018, The Adversarial Robustness Toolbox (ART) Authors' |
24 | | -author = 'Maria-Irina Nicolae' |
| 23 | +project = "Adversarial Robustness Toolbox" |
| 24 | +copyright = "2018, The Adversarial Robustness Toolbox (ART) Authors" |
| 25 | +author = "Maria-Irina Nicolae" |
25 | 26 |
|
26 | 27 | # The short X.Y version |
27 | | -version = '1.7' |
| 28 | +version = "1.7" |
28 | 29 | # The full version, including alpha/beta/rc tags |
29 | | -release = '1.7.0-dev' |
| 30 | +release = "1.7.0-dev" |
30 | 31 |
|
31 | 32 |
|
32 | 33 | # -- General configuration --------------------------------------------------- |
|
38 | 39 | # Add any Sphinx extension module names here, as strings. They can be |
39 | 40 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
40 | 41 | # ones. |
41 | | -extensions = [ |
42 | | - 'sphinx.ext.viewcode', |
43 | | - 'sphinx.ext.autodoc' |
44 | | -] |
| 42 | +extensions = ["sphinx.ext.viewcode", "sphinx.ext.autodoc"] |
45 | 43 |
|
46 | 44 | # Add any paths that contain templates here, relative to this directory. |
47 | | -templates_path = ['_templates'] |
| 45 | +templates_path = ["_templates"] |
48 | 46 |
|
49 | 47 | # The suffix(es) of source filenames. |
50 | 48 | # You can specify multiple suffix as a list of string: |
51 | 49 | # |
52 | 50 | # source_suffix = ['.rst', '.md'] |
53 | | -source_suffix = '.rst' |
| 51 | +source_suffix = ".rst" |
54 | 52 |
|
55 | 53 | # The master toctree document. |
56 | | -master_doc = 'index' |
| 54 | +master_doc = "index" |
57 | 55 |
|
58 | 56 | # The language for content autogenerated by Sphinx. Refer to documentation |
59 | 57 | # for a list of supported languages. |
|
65 | 63 | # List of patterns, relative to source directory, that match files and |
66 | 64 | # directories to ignore when looking for source files. |
67 | 65 | # This pattern also affects html_static_path and html_extra_path . |
68 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 66 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
69 | 67 |
|
70 | 68 | # The name of the Pygments (syntax highlighting) style to use. |
71 | | -pygments_style = 'sphinx' |
| 69 | +pygments_style = "sphinx" |
72 | 70 |
|
73 | 71 |
|
74 | 72 | # -- Options for HTML output ------------------------------------------------- |
|
78 | 76 | # |
79 | 77 | # html_theme = 'alabaster' |
80 | 78 |
|
81 | | -if os.environ.get('READTHEDOCS') != 'True': |
| 79 | +if os.environ.get("READTHEDOCS") != "True": |
82 | 80 | try: |
83 | 81 | import sphinx_rtd_theme |
84 | 82 | except ImportError: |
85 | 83 | pass # assume we have sphinx >= 1.3 |
86 | 84 | else: |
87 | 85 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
88 | | - html_theme = 'sphinx_rtd_theme' |
| 86 | + html_theme = "sphinx_rtd_theme" |
89 | 87 |
|
90 | 88 | # Theme options are theme-specific and customize the look and feel of a theme |
91 | 89 | # further. For a list of options available for each theme, see the |
|
112 | 110 | # -- Options for HTMLHelp output --------------------------------------------- |
113 | 111 |
|
114 | 112 | # Output file base name for HTML help builder. |
115 | | -htmlhelp_basename = 'adversarial-robustness-toolboxdoc' |
| 113 | +htmlhelp_basename = "adversarial-robustness-toolboxdoc" |
116 | 114 |
|
117 | 115 |
|
118 | 116 | # -- Options for LaTeX output ------------------------------------------------ |
|
121 | 119 | # The paper size ('letterpaper' or 'a4paper'). |
122 | 120 | # |
123 | 121 | # 'papersize': 'letterpaper', |
124 | | - |
125 | 122 | # The font size ('10pt', '11pt' or '12pt'). |
126 | 123 | # |
127 | 124 | # 'pointsize': '10pt', |
128 | | - |
129 | 125 | # Additional stuff for the LaTeX preamble. |
130 | 126 | # |
131 | 127 | # 'preamble': '', |
132 | | - |
133 | 128 | # Latex figure (float) alignment |
134 | 129 | # |
135 | 130 | # 'figure_align': 'htbp', |
|
139 | 134 | # (source start file, target name, title, |
140 | 135 | # author, documentclass [howto, manual, or own class]). |
141 | 136 | latex_documents = [ |
142 | | - (master_doc, 'adversarial-robustness-toolbox.tex', 'adversarial-robustness-toolbox Documentation', |
143 | | - 'Maria-Irina Nicolae', 'manual'), |
| 137 | + ( |
| 138 | + master_doc, |
| 139 | + "adversarial-robustness-toolbox.tex", |
| 140 | + "adversarial-robustness-toolbox Documentation", |
| 141 | + "Maria-Irina Nicolae", |
| 142 | + "manual", |
| 143 | + ), |
144 | 144 | ] |
145 | 145 |
|
146 | 146 |
|
|
149 | 149 | # One entry per manual page. List of tuples |
150 | 150 | # (source start file, name, description, authors, manual section). |
151 | 151 | man_pages = [ |
152 | | - (master_doc, 'adversarial-robustness-toolbox', 'adversarial-robustness-toolbox Documentation', |
153 | | - [author], 1) |
| 152 | + (master_doc, "adversarial-robustness-toolbox", "adversarial-robustness-toolbox Documentation", [author], 1) |
154 | 153 | ] |
155 | 154 |
|
156 | 155 |
|
|
160 | 159 | # (source start file, target name, title, author, |
161 | 160 | # dir menu entry, description, category) |
162 | 161 | texinfo_documents = [ |
163 | | - (master_doc, 'adversarial-robustness-toolbox', 'adversarial-robustness-toolbox Documentation', |
164 | | - author, 'adversarial-robustness-toolbox', 'One line description of project.', |
165 | | - 'Miscellaneous'), |
| 162 | + ( |
| 163 | + master_doc, |
| 164 | + "adversarial-robustness-toolbox", |
| 165 | + "adversarial-robustness-toolbox Documentation", |
| 166 | + author, |
| 167 | + "adversarial-robustness-toolbox", |
| 168 | + "One line description of project.", |
| 169 | + "Miscellaneous", |
| 170 | + ), |
166 | 171 | ] |
167 | 172 |
|
168 | 173 |
|
|
0 commit comments