GNUnet  0.18.1
conf Namespace Reference

Variables

string project = 'GNUnet'
 
string copyright = '2022, GNUnet Project'
 
string author = 'GNUnet Project'
 
list extensions
 
list templates_path = ['_templates']
 
list exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
string html_theme = 'sphinx_rtd_theme'
 
dictionary html_theme_options
 
bool man_make_section_directory = False
 
list man_pages
 
list html_static_path = ['_static']
 
list html_css_files
 
string html_logo = "_static/images/gnunet-blue.png"
 
bool todo_include_todos = True
 
string primary_domain = "c"
 
string highlight_language = "c"
 
string rst_prolog
 
string rst_epilog
 

Variable Documentation

◆ project

string conf.project = 'GNUnet'

Definition at line 22 of file conf.py.

◆ copyright

string conf.copyright = '2022, GNUnet Project'

Definition at line 23 of file conf.py.

◆ author

string conf.author = 'GNUnet Project'

Definition at line 24 of file conf.py.

◆ extensions

list conf.extensions
Initial value:
1 = [
2  'httpdomain.httpdomain',
3  'typescriptdomain',
4  'sphinx.ext.todo',
5  'sphinx_rtd_theme',
6  #'breathe'
7 ]

Definition at line 33 of file conf.py.

◆ templates_path

list conf.templates_path = ['_templates']

Definition at line 48 of file conf.py.

◆ exclude_patterns

list conf.exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

Definition at line 53 of file conf.py.

◆ html_theme

string conf.html_theme = 'sphinx_rtd_theme'

Definition at line 61 of file conf.py.

◆ html_theme_options

dictionary conf.html_theme_options
Initial value:
1 = {
2  'logo_only': True,
3  'display_version': False,
4  'prev_next_buttons_location': 'bottom',
5  'style_external_links': False,
6  #'vcs_pageview_mode': '',
7  'style_nav_header_background': 'transparent', # Possibly problematic with our CSP
8  # Toc options
9  'collapse_navigation': True,
10  'sticky_navigation': True,
11  #'navigation_depth': 4,
12  'includehidden': True,
13  'titles_only': False
14 }

Definition at line 63 of file conf.py.

◆ man_make_section_directory

bool conf.man_make_section_directory = False

Definition at line 78 of file conf.py.

◆ man_pages

list conf.man_pages
Initial value:
1 = [
2  ('about', 'gnunet', 'About GNUnet', '', '1'),
3  ('installing', 'gnunet', 'Installing GNUnet', '', '2'),
4  ('users/start', 'gnunet', 'Starting and stopping', '', '3'),
5  ('users/gns', 'gnunet', 'The GNU Name System', '', '4'),
6  ('users/reclaim', 'gnunet', 're:claimID', '', '5'),
7  ('users/fs', 'gnunet', 'GNUnet File-Sharing', '', '6'),
8  ('users/vpn', 'gnunet', 'GNUnet VPN', '', '7'),
9  ('users/messenger', 'gnunet', 'GNUnet Messenger', '', '8'),
10  ('users/configuration', 'gnunet', 'GNUnet advanced configuration', '', '9'),
11  ('developers/contributing', 'gnunet-dev', 'Contributing', '', '1'),
12  ('developers/style', 'gnunet-dev', 'Style and workflow', '', '2'),
13  ('developers/util/index', 'gnunet-dev', 'libgnunetutil', '', '3'),
14  ('developers/subsystems/index', 'gnunet-dev', 'Architecture', '', '4'),
15  ('developers/rest/index', 'gnunet-dev', 'REST API', '', '5'),
16  ('developers/tutorial', 'gnunet-dev', 'GNUnet Developer Tutorial', '', '6'),
17  ('livingstandards', 'lsd', 'Living Standards', '', '1'),
18  ('gana/intro', 'gana', 'GNUnet Assigned Numbers Authority (GANA)', '', '1'),
19  ('gana/gnu_name_system_record_types', 'gana', 'Registry for GNU Name System record types', '', '2'),
20  ('gana/tlds', 'gana', 'Registry for GNU Name System default Top-Level-Domains', '', '3'),
21  ('gana/gnunet_dht_block_types', 'gana', 'Registry for DHT block types', '', '4'),
22  ('gana/gnunet_signatures', 'gana', 'Registry for Signature purposes', '', '5'),
23 
24 ]

Definition at line 79 of file conf.py.

◆ html_static_path

list conf.html_static_path = ['_static']

Definition at line 107 of file conf.py.

◆ html_css_files

list conf.html_css_files
Initial value:
1 = [
2  'css/custom.css',
3 ]

Definition at line 111 of file conf.py.

◆ html_logo

string conf.html_logo = "_static/images/gnunet-blue.png"

Definition at line 115 of file conf.py.

◆ todo_include_todos

bool conf.todo_include_todos = True

Definition at line 118 of file conf.py.

◆ primary_domain

string conf.primary_domain = "c"

Definition at line 120 of file conf.py.

◆ highlight_language

string conf.highlight_language = "c"

Definition at line 122 of file conf.py.

◆ rst_prolog

string conf.rst_prolog
Initial value:
1 = f"""
2 .. role:: c(code)
3  :language: c
4 
5 .. role:: bolditalic
6  :class: bolditalic
7 """

Definition at line 124 of file conf.py.

◆ rst_epilog

string conf.rst_epilog
Initial value:
1 = """
2 """

Definition at line 132 of file conf.py.