|
15 | 15 | import sys |
16 | 16 |
|
17 | 17 |
|
18 | | -sys.path.append(os.path.abspath('../')) |
| 18 | +sys.path.append(os.path.abspath("../")) |
19 | 19 |
|
20 | 20 | from filer import __version__ # NOQA |
21 | 21 |
|
|
33 | 33 | # Add any Sphinx extension module names here, as strings. They can be extensions |
34 | 34 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
35 | 35 | extensions = [ |
36 | | - 'sphinx.ext.autodoc', |
37 | | - 'sphinx.ext.doctest', |
38 | | - 'sphinx.ext.intersphinx', |
39 | | - 'sphinx.ext.todo', |
40 | | - 'sphinxcontrib.spelling', |
| 36 | + "sphinx.ext.autodoc", |
| 37 | + "sphinx.ext.doctest", |
| 38 | + "sphinx.ext.intersphinx", |
| 39 | + "sphinx.ext.todo", |
| 40 | + "sphinxcontrib.spelling", |
41 | 41 | "sphinx_copybutton", |
42 | 42 | "sphinxext.opengraph", |
43 | | - 'sphinxcontrib.images', |
| 43 | + "sphinxcontrib.images", |
44 | 44 | ] |
45 | 45 |
|
46 | 46 | # Add any paths that contain templates here, relative to this directory. |
47 | | -templates_path = ['_templates'] |
| 47 | +templates_path = ["_templates"] |
48 | 48 |
|
49 | 49 | # The suffix of source filenames. |
50 | | -source_suffix = '.rst' |
| 50 | +source_suffix = ".rst" |
51 | 51 |
|
52 | 52 | # The encoding of source files. |
53 | 53 | # source_encoding = 'utf-8-sig' |
54 | 54 |
|
55 | 55 | # The master toctree document. |
56 | | -master_doc = 'index' |
| 56 | +master_doc = "index" |
57 | 57 |
|
58 | 58 | # General information about the project. |
59 | | -project = 'django-filer' |
60 | | -copyright = '%s, Stefan Foulis' % (datetime.date.today().year,) |
| 59 | +project = "django-filer" |
| 60 | +copyright = "%s, Stefan Foulis" % (datetime.date.today().year,) |
61 | 61 |
|
62 | 62 | # The version info for the project you're documenting, acts as replacement for |
63 | 63 | # |version| and |release|, also used in various other places throughout the |
64 | 64 | # built documents. |
65 | 65 | # |
66 | 66 | # The short X.Y version. |
67 | | -version = '.'.join(__version__.split('.')[0:2]) |
| 67 | +version = ".".join(__version__.split(".")[:2]) |
68 | 68 | # The full version, including alpha/beta/rc tags. |
69 | 69 | release = __version__ |
70 | 70 |
|
|
80 | 80 |
|
81 | 81 | # List of patterns, relative to source directory, that match files and |
82 | 82 | # directories to ignore when looking for source files. |
83 | | -exclude_patterns = ['_build', '_images', 'README.rst'] |
| 83 | +exclude_patterns = ["_build", "_images", "README.rst"] |
84 | 84 |
|
85 | 85 | # The reST default role (used for this markup: `text`) to use for all documents. |
86 | 86 | # default_role = None |
|
97 | 97 | # show_authors = False |
98 | 98 |
|
99 | 99 | # The name of the Pygments (syntax highlighting) style to use. |
100 | | -pygments_style = 'sphinx' |
| 100 | +pygments_style = "sphinx" |
101 | 101 |
|
102 | 102 | # A list of ignored prefixes for module index sorting. |
103 | 103 | # modindex_common_prefix = [] |
|
107 | 107 |
|
108 | 108 | # The theme to use for HTML and HTML Help pages. See the documentation for |
109 | 109 | # a list of builtin themes. |
110 | | -html_theme = 'furo' |
| 110 | +html_theme = "furo" |
111 | 111 |
|
112 | 112 | # Theme options are theme-specific and customize the look and feel of a theme |
113 | 113 | # further. For a list of options available for each theme, see the |
|
138 | 138 | # Add any paths that contain custom static files (such as style sheets) here, |
139 | 139 | # relative to this directory. They are copied after the builtin static files, |
140 | 140 | # so a file named "default.css" will overwrite the builtin "default.css". |
141 | | -html_static_path = ['_static'] |
| 141 | +html_static_path = ["_static"] |
142 | 142 |
|
143 | 143 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
144 | 144 | # using the given strftime format. |
|
182 | 182 | # html_file_suffix = '' |
183 | 183 |
|
184 | 184 | # Output file base name for HTML help builder. |
185 | | -htmlhelp_basename = 'django-filerdoc' |
| 185 | +htmlhelp_basename = "django-filerdoc" |
186 | 186 |
|
187 | 187 |
|
188 | 188 | # -- Options for LaTeX output -------------------------------------------------- |
|
196 | 196 | # Grouping the document tree into LaTeX files. List of tuples |
197 | 197 | # (source start file, target name, title, author, documentclass [howto/manual]). |
198 | 198 | latex_documents = [ |
199 | | - ('index', 'django-filer.tex', 'django-filer Documentation', 'Stefan Foulis', 'manual'), |
| 199 | + ( |
| 200 | + "index", |
| 201 | + "django-filer.tex", |
| 202 | + "django-filer Documentation", |
| 203 | + "Stefan Foulis", |
| 204 | + "manual", |
| 205 | + ), |
200 | 206 | ] |
201 | 207 |
|
202 | 208 | # The name of an image file (relative to this directory) to place at the top of |
|
228 | 234 | # One entry per manual page. List of tuples |
229 | 235 | # (source start file, name, description, authors, manual section). |
230 | 236 | man_pages = [ |
231 | | - ('index', 'django-filer', 'django-filer Documentation', ['Stefan Foulis'], 1) |
| 237 | + ("index", "django-filer", "django-filer Documentation", ["Stefan Foulis"], 1) |
232 | 238 | ] |
233 | 239 |
|
234 | 240 |
|
235 | 241 | # Example configuration for intersphinx: refer to the Python standard library. |
236 | | -intersphinx_mapping = {'http://docs.python.org/': None} |
| 242 | +intersphinx_mapping = { |
| 243 | + "python": ("https://docs.python.org/3", None), |
| 244 | + "django": ( |
| 245 | + "https://docs.djangoproject.com/en/stable/", |
| 246 | + "https://docs.djangoproject.com/en/stable/objects.inv", |
| 247 | + ), |
| 248 | +} |
237 | 249 |
|
238 | 250 | images_config = { |
239 | | - 'override_image_directive': True, |
| 251 | + "override_image_directive": True, |
240 | 252 | } |
0 commit comments