Mercurial > hg > auditok
comparison doc/conf.py @ 439:ca8090edca2f
Merge branch 'master' of https://github.com/amsehili/auditok
| author | www-data <www-data@c4dm-xenserv-virt2.eecs.qmul.ac.uk> |
|---|---|
| date | Wed, 30 Oct 2024 22:17:58 +0000 |
| parents | 2644f997b6e0 |
| children |
comparison
equal
deleted
inserted
replaced
| 436:87048a881402 | 439:ca8090edca2f |
|---|---|
| 11 # | 11 # |
| 12 # All configuration values have a default; values that are commented out | 12 # All configuration values have a default; values that are commented out |
| 13 # serve to show the default. | 13 # serve to show the default. |
| 14 | 14 |
| 15 import ast | 15 import ast |
| 16 import os | |
| 17 import re | 16 import re |
| 18 import sys | 17 import sys |
| 18 from datetime import datetime | |
| 19 | 19 |
| 20 # If extensions (or modules to document with autodoc) are in another directory, | 20 # If extensions (or modules to document with autodoc) are in another directory, |
| 21 # add these directories to sys.path here. If the directory is relative to the | 21 # add these directories to sys.path here. If the directory is relative to the |
| 22 # documentation root, use os.path.abspath to make it absolute, like shown here. | 22 # documentation root, use os.path.abspath to make it absolute, like shown here. |
| 23 # sys.path.insert(0, os.path.abspath('.')) | 23 # sys.path.insert(0, os.path.abspath('.')) |
| 61 # The master toctree document. | 61 # The master toctree document. |
| 62 master_doc = "index" | 62 master_doc = "index" |
| 63 | 63 |
| 64 # General information about the project. | 64 # General information about the project. |
| 65 project = "auditok" | 65 project = "auditok" |
| 66 copyright = "2015-2024, Amine Sehili" | 66 copyright = f"2015-{datetime.now().year}, Amine Sehili" |
| 67 author = "Amine Sehili" | 67 author = "Amine Sehili" |
| 68 | 68 |
| 69 # The version info for the project you're documenting, acts as replacement for | 69 # The version info for the project you're documenting, acts as replacement for |
| 70 # |version| and |release|, also used in various other places throughout the | 70 # |version| and |release|, also used in various other places throughout the |
| 71 # built documents. | 71 # built documents. |
| 78 # The language for content autogenerated by Sphinx. Refer to documentation | 78 # The language for content autogenerated by Sphinx. Refer to documentation |
| 79 # for a list of supported languages. | 79 # for a list of supported languages. |
| 80 # | 80 # |
| 81 # This is also used if you do content translation via gettext catalogs. | 81 # This is also used if you do content translation via gettext catalogs. |
| 82 # Usually you set "language" from the command line for these cases. | 82 # Usually you set "language" from the command line for these cases. |
| 83 language = None | 83 language = "en" |
| 84 | 84 |
| 85 # There are two options for replacing |today|: either, you set today to some | 85 # There are two options for replacing |today|: either, you set today to some |
| 86 # non-false value, then it is used: | 86 # non-false value, then it is used: |
| 87 # today = '' | 87 # today = '' |
| 88 # Else, today_fmt is used as the format for a strftime call. | 88 # Else, today_fmt is used as the format for a strftime call. |
| 106 # If true, sectionauthor and moduleauthor directives will be shown in the | 106 # If true, sectionauthor and moduleauthor directives will be shown in the |
| 107 # output. They are ignored by default. | 107 # output. They are ignored by default. |
| 108 # show_authors = False | 108 # show_authors = False |
| 109 | 109 |
| 110 # The name of the Pygments (syntax highlighting) style to use. | 110 # The name of the Pygments (syntax highlighting) style to use. |
| 111 pygments_style = "sphinx" | 111 pygments_style = "native" |
| 112 | 112 |
| 113 # A list of ignored prefixes for module index sorting. | 113 # A list of ignored prefixes for module index sorting. |
| 114 # modindex_common_prefix = [] | 114 # modindex_common_prefix = [] |
| 115 | 115 |
| 116 # If true, keep warnings as "system message" paragraphs in the built documents. | 116 # If true, keep warnings as "system message" paragraphs in the built documents. |
| 122 | 122 |
| 123 # -- Options for HTML output ---------------------------------------------- | 123 # -- Options for HTML output ---------------------------------------------- |
| 124 | 124 |
| 125 # The theme to use for HTML and HTML Help pages. See the documentation for | 125 # The theme to use for HTML and HTML Help pages. See the documentation for |
| 126 # a list of builtin themes. | 126 # a list of builtin themes. |
| 127 # html_theme = 'sphinxdoc' | 127 html_theme = "sphinx_rtd_theme" |
| 128 | 128 |
| 129 | 129 |
| 130 # on_rtd is whether we are on readthedocs.org | |
| 131 on_rtd = os.environ.get("READTHEDOCS", None) == "True" | |
| 132 if not on_rtd: # only import and set the theme if we're building docs locally | |
| 133 import sphinx_rtd_theme | |
| 134 | |
| 135 html_theme = "sphinx_rtd_theme" | |
| 136 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | |
| 137 html_theme_options = { | 130 html_theme_options = { |
| 138 "logo_only": True, | 131 "logo_only": True, |
| 139 "style_nav_header_background": "#000000", | 132 "style_nav_header_background": "#000000", |
| 140 } | 133 } |
| 141 | 134 |
