conf Namespace Reference

Variables
string	project = 'GANA'
string	copyright = '2024, 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_sidebars
dictionary	html_theme_options
list	html_static_path = ['_static']
string	html_logo = "images/gnunet-blue.png"
bool	todo_include_todos = True
string	primary_domain = "c"
string	highlight_language = "c"
string	rst_prolog
string	rst_epilog
bool	man_make_section_directory = False
list	man_pages
list	html_css_files
string	smv_tag_whitelist = r'^.*$'
string	smv_branch_whitelist = 'master'
	smv_remote_whitelist = None
string	smv_released_pattern = r'^tags/.*$'
string	smv_outputdir_format = '{ref.name}'
bool	smv_prefer_remote_refs = False

Variable Documentation

project

string conf.project = 'GANA'

Definition at line 22 of file conf.py.

copyright

string conf.copyright = '2024, 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:

=  [
  'httpdomain.httpdomain',
  'typescriptdomain',
  'sphinx.ext.todo',
  #'sphinx_book_theme',
  #'breathe'
]

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_sidebars

dictionary conf.html_sidebars

Initial value:

=  {
    #"**": ["navbar-logo.html", "sbt-sidebar-nav.html", "search-field.html"]
    "**": ["search-field.html", "sbt-sidebar-nav.html"]
}

Definition at line 63 of file conf.py.

html_theme_options

dictionary conf.html_theme_options

Initial value:

=  {
    #'logo_only': True,
    #'display_version': False,
    #'prev_next_buttons_location': 'bottom',
    #'style_external_links': False,
    #'vcs_pageview_mode': '',
    #'style_nav_header_background': 'transparent', # Possibly problematic with our CSP
    # Toc options
    #'collapse_navigation': True,
    #'sticky_navigation': True,
    #'navigation_depth': 4,
    #'includehidden': True,
    #'titles_only': False
    #"navbar_start": ["navbar-logo"],
    #"header_links_before_dropdown": 8,
    #"article_header_start": ["breadcrumbs.html"],
    #"navbar_center": ["navbar-nav"],
    #"navbar_end": [],
    #"navbar_persistent": [],
}

Definition at line 68 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 92 of file conf.py.

html_logo

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

Definition at line 100 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = True

Definition at line 103 of file conf.py.

primary_domain

string conf.primary_domain = "c"

Definition at line 105 of file conf.py.

highlight_language

string conf.highlight_language = "c"

Definition at line 107 of file conf.py.

rst_prolog

string conf.rst_prolog

Initial value:

=  f"""
.. role:: c(code)
   :language: c
 
.. role:: bolditalic
   :class: bolditalic
"""

Definition at line 109 of file conf.py.

rst_epilog

string conf.rst_epilog

Initial value:

=  """
"""

Definition at line 117 of file conf.py.

man_make_section_directory

bool conf.man_make_section_directory = False

Definition at line 74 of file conf.py.

man_pages

list conf.man_pages

Initial value:

=  [
        ('about', 'gnunet', 'About GNUnet', '', '1'),
        ('installing', 'gnunet', 'Installing GNUnet', '', '2'),
        ('users/start', 'gnunet', 'Starting and stopping', '', '3'),
        ('users/gns', 'gnunet', 'The GNU Name System', '', '4'),
        ('users/reclaim', 'gnunet', 're:claimID', '', '5'),
        ('users/fs', 'gnunet', 'GNUnet File-Sharing', '', '6'),
        ('users/vpn', 'gnunet', 'GNUnet VPN', '', '7'),
        ('users/messenger', 'gnunet', 'GNUnet Messenger', '', '8'),
        ('users/configuration', 'gnunet', 'GNUnet advanced configuration', '', '9'),
        ('developers/contributing', 'gnunet-dev', 'Contributing', '', '1'),
        ('developers/style', 'gnunet-dev', 'Style and workflow', '', '2'),
        ('developers/util', 'gnunet-dev', 'libgnunetutil', '', '3'),
        ('developers/rest/rest', 'gnunet-dev', 'REST API', '', '5'),
        ('developers/tutorial', 'gnunet-dev', 'GNUnet Developer Tutorial', '', '6'),
        ('livingstandards', 'lsd', 'Living Standards', '', '1'),
]

Definition at line 75 of file conf.py.

html_css_files

list conf.html_css_files

Initial value:

=  [
    'css/custom.css',
]

Definition at line 100 of file conf.py.

smv_tag_whitelist

string conf.smv_tag_whitelist = r'^.*$'

Definition at line 127 of file conf.py.

smv_branch_whitelist

string conf.smv_branch_whitelist = 'master'

Definition at line 131 of file conf.py.

smv_remote_whitelist

conf.smv_remote_whitelist = None

Definition at line 134 of file conf.py.

smv_released_pattern

string conf.smv_released_pattern = r'^tags/.*$'

Definition at line 137 of file conf.py.

smv_outputdir_format

string conf.smv_outputdir_format = '{ref.name}'

Definition at line 140 of file conf.py.

smv_prefer_remote_refs

bool conf.smv_prefer_remote_refs = False

Definition at line 143 of file conf.py.