GNUnet  0.17.6
conf.py
Go to the documentation of this file.
1 # Configuration file for the Sphinx documentation builder.
2 #
3 # This file only contains a selection of the most common options. For a full
4 # list see the documentation:
5 # https://www.sphinx-doc.org/en/master/usage/configuration.html
6 
7 # -- Path setup --------------------------------------------------------------
8 
9 # If extensions (or modules to document with autodoc) are in another directory,
10 # add these directories to sys.path here. If the directory is relative to the
11 # documentation root, use os.path.abspath to make it absolute, like shown here.
12 #
13 # import os
14 # import sys
15 # sys.path.insert(0, os.path.abspath('.'))
16 
17 
18 # -- Project information -----------------------------------------------------
19 
20 project = 'GNUnet'
21 copyright = '2022, GNUnet Project'
22 author = 'GNUnet Project'
23 
24 
25 # -- General configuration ---------------------------------------------------
26 
27 # Add any Sphinx extension module names here, as strings. They can be
28 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
29 # ones.
30 extensions = [
31  'sphinx.ext.todo',
32  'sphinx_rtd_theme',
33  #'breathe'
34 ]
35 
36 #breathe_projects = {
37 # "gnunet": "../gnunet/doc/doxygen/xml/",
38 #}
39 
40 #breathe_default_project = "gnunet"
41 
42 # Add any paths that contain templates here, relative to this directory.
43 templates_path = ['_templates']
44 
45 # List of patterns, relative to source directory, that match files and
46 # directories to ignore when looking for source files.
47 # This pattern also affects html_static_path and html_extra_path.
48 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
49 
50 
51 # -- Options for HTML output -------------------------------------------------
52 
53 # The theme to use for HTML and HTML Help pages. See the documentation for
54 # a list of builtin themes.
55 #
56 html_theme = 'sphinx_rtd_theme'
57 
58 html_theme_options = {
59  'logo_only': True,
60  'display_version': False,
61  'prev_next_buttons_location': 'bottom',
62  'style_external_links': False,
63  #'vcs_pageview_mode': '',
64  'style_nav_header_background': 'transparent', # Possibly problematic with our CSP
65  # Toc options
66  'collapse_navigation': True,
67  'sticky_navigation': True,
68  #'navigation_depth': 4,
69  'includehidden': True,
70  'titles_only': False
71 }
72 
73 # Add any paths that contain custom static files (such as style sheets) here,
74 # relative to this directory. They are copied after the builtin static files,
75 # so a file named "default.css" will overwrite the builtin "default.css".
76 html_static_path = ['_static']
77 
78 # These paths are either relative to html_static_path
79 # or fully qualified paths (eg. https://...)
80 html_css_files = [
81  'css/custom.css',
82 ]
83 
84 html_logo = "_static/images/gnunet-blue.png"
85 
86 myst_enable_extensions = [
87  "amsmath",
88  "colon_fence",
89  "deflist",
90  "dollarmath",
91  "fieldlist",
92  "html_admonition",
93  "html_image",
94  "linkify",
95  "replacements",
96  "smartquotes",
97  "strikethrough",
98  "substitution",
99  "tasklist",
100 ]
101 
102 # Display to-do items in docs
103 todo_include_todos = True
104 
105 myst_heading_anchors = 3
106 
107 primary_domain = "c"
108 
109 highlight_language = "c"
110 
111 rst_prolog = f"""
112 .. role:: c(code)
113  :language: c
114 
115 .. role:: bolditalic
116  :class: bolditalic
117 """
118 
119 rst_epilog = """
120 """
121 
122