dockonsurf / docs / source / conf.py @ 86afe2ce
Historique | Voir | Annoter | Télécharger (1,97 ko)
1 | 4fd2e6f0 | Carles Martí | # Configuration file for the Sphinx documentation builder.
|
---|---|---|---|
2 | 4fd2e6f0 | Carles Martí | #
|
3 | 4fd2e6f0 | Carles Martí | # This file only contains a selection of the most common options. For a full
|
4 | 4fd2e6f0 | Carles Martí | # list see the documentation:
|
5 | 4fd2e6f0 | Carles Martí | # https://www.sphinx-doc.org/en/master/usage/configuration.html
|
6 | 4fd2e6f0 | Carles Martí | |
7 | 4fd2e6f0 | Carles Martí | # -- Path setup --------------------------------------------------------------
|
8 | 4fd2e6f0 | Carles Martí | |
9 | 4fd2e6f0 | Carles Martí | # If extensions (or modules to document with autodoc) are in another directory,
|
10 | 4fd2e6f0 | Carles Martí | # add these directories to sys.path here. If the directory is relative to the
|
11 | 4fd2e6f0 | Carles Martí | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
12 | 4fd2e6f0 | Carles Martí | #
|
13 | 4fd2e6f0 | Carles Martí | # import os
|
14 | 4fd2e6f0 | Carles Martí | # import sys
|
15 | 4fd2e6f0 | Carles Martí | # sys.path.insert(0, os.path.abspath('.'))
|
16 | 4fd2e6f0 | Carles Martí | |
17 | 4fd2e6f0 | Carles Martí | |
18 | 4fd2e6f0 | Carles Martí | # -- Project information -----------------------------------------------------
|
19 | 4fd2e6f0 | Carles Martí | |
20 | 4fd2e6f0 | Carles Martí | project = 'DockOnSurf'
|
21 | f6624e99 | Carles Martí | # copyright = '2021, Carles Martí'
|
22 | 4fd2e6f0 | Carles Martí | author = 'Carles Martí'
|
23 | 4fd2e6f0 | Carles Martí | |
24 | 4fd2e6f0 | Carles Martí | # The full version, including alpha/beta/rc tags
|
25 | 4fd2e6f0 | Carles Martí | release = '0.0.1'
|
26 | 4fd2e6f0 | Carles Martí | |
27 | 4fd2e6f0 | Carles Martí | |
28 | 4fd2e6f0 | Carles Martí | # -- General configuration ---------------------------------------------------
|
29 | 4fd2e6f0 | Carles Martí | |
30 | 4fd2e6f0 | Carles Martí | # Add any Sphinx extension module names here, as strings. They can be
|
31 | 4fd2e6f0 | Carles Martí | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
32 | 4fd2e6f0 | Carles Martí | # ones.
|
33 | 4fd2e6f0 | Carles Martí | extensions = [ |
34 | 4fd2e6f0 | Carles Martí | ] |
35 | 4fd2e6f0 | Carles Martí | |
36 | 4fd2e6f0 | Carles Martí | # Add any paths that contain templates here, relative to this directory.
|
37 | 4fd2e6f0 | Carles Martí | templates_path = ['_templates']
|
38 | 4fd2e6f0 | Carles Martí | |
39 | 4fd2e6f0 | Carles Martí | # List of patterns, relative to source directory, that match files and
|
40 | 4fd2e6f0 | Carles Martí | # directories to ignore when looking for source files.
|
41 | 4fd2e6f0 | Carles Martí | # This pattern also affects html_static_path and html_extra_path.
|
42 | 4fd2e6f0 | Carles Martí | exclude_patterns = [] |
43 | 4fd2e6f0 | Carles Martí | |
44 | 4fd2e6f0 | Carles Martí | |
45 | 4fd2e6f0 | Carles Martí | # -- Options for HTML output -------------------------------------------------
|
46 | 4fd2e6f0 | Carles Martí | |
47 | 4fd2e6f0 | Carles Martí | # The theme to use for HTML and HTML Help pages. See the documentation for
|
48 | 4fd2e6f0 | Carles Martí | # a list of builtin themes.
|
49 | 4fd2e6f0 | Carles Martí | #
|
50 | 4fd2e6f0 | Carles Martí | html_theme = 'sphinx_rtd_theme'
|
51 | 4fd2e6f0 | Carles Martí | |
52 | 4fd2e6f0 | Carles Martí | # Add any paths that contain custom static files (such as style sheets) here,
|
53 | 4fd2e6f0 | Carles Martí | # relative to this directory. They are copied after the builtin static files,
|
54 | 4fd2e6f0 | Carles Martí | # so a file named "default.css" will overwrite the builtin "default.css".
|
55 | 4fd2e6f0 | Carles Martí | html_static_path = ['_static']
|
56 | 86afe2ce | Carles Martí | |
57 | 86afe2ce | Carles Martí | # logo
|
58 | 86afe2ce | Carles Martí | html_logo = 'logo-transp.png'
|
59 | 86afe2ce | Carles Martí | |
60 | 86afe2ce | Carles Martí | html_theme_options = { |
61 | 86afe2ce | Carles Martí | 'logo_only': True, |
62 | 86afe2ce | Carles Martí | 'display_version': False, |
63 | 86afe2ce | Carles Martí | } |