gana

GNUnet Assigned Numbers Authority
Log | Files | Refs | README | LICENSE

conf.py (3376B)

      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 import sys
     20 import os
     21 
     22 project = 'GANA'
     23 copyright = '2024, GNUnet Project'
     24 author = 'GNUnet Project'
     25 
     26 sys.path.append(os.path.abspath("_exts"))
     27 
     28 # -- General configuration ---------------------------------------------------
     29 
     30 # Add any Sphinx extension module names here, as strings. They can be
     31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
     32 # ones.
     33 extensions = [
     34   'httpdomain.httpdomain',
     35   'typescriptdomain',
     36   'sphinx.ext.todo',
     37   #'sphinx_book_theme',
     38   #'breathe'
     39 ]
     40 
     41 #breathe_projects = {
     42 #    "gnunet": "../gnunet/doc/doxygen/xml/",
     43 #}
     44 
     45 #breathe_default_project = "gnunet"
     46 
     47 # Add any paths that contain templates here, relative to this directory.
     48 templates_path = ['_templates']
     49 
     50 # List of patterns, relative to source directory, that match files and
     51 # directories to ignore when looking for source files.
     52 # This pattern also affects html_static_path and html_extra_path.
     53 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
     54 
     55 
     56 # -- Options for HTML output -------------------------------------------------
     57 
     58 # The theme to use for HTML and HTML Help pages.  See the documentation for
     59 # a list of builtin themes.
     60 #
     61 html_theme = 'sphinx_rtd_theme'
     62 
     63 html_sidebars = {
     64     #"**": ["navbar-logo.html", "sbt-sidebar-nav.html", "search-field.html"]
     65     "**": ["search-field.html", "sbt-sidebar-nav.html"]
     66 }
     67 
     68 html_theme_options = {
     69     #'logo_only': True,
     70     #'display_version': False,
     71     #'prev_next_buttons_location': 'bottom',
     72     #'style_external_links': False,
     73     #'vcs_pageview_mode': '',
     74     #'style_nav_header_background': 'transparent', # Possibly problematic with our CSP
     75     # Toc options
     76     #'collapse_navigation': True,
     77     #'sticky_navigation': True,
     78     #'navigation_depth': 4,
     79     #'includehidden': True,
     80     #'titles_only': False
     81     #"navbar_start": ["navbar-logo"],
     82     #"header_links_before_dropdown": 8,
     83     #"article_header_start": ["breadcrumbs.html"],
     84     #"navbar_center": ["navbar-nav"],
     85     #"navbar_end": [],
     86     #"navbar_persistent": [],
     87 }
     88 
     89 # Add any paths that contain custom static files (such as style sheets) here,
     90 # relative to this directory. They are copied after the builtin static files,
     91 # so a file named "default.css" will overwrite the builtin "default.css".
     92 html_static_path = ['_static']
     93 
     94 # These paths are either relative to html_static_path
     95 # or fully qualified paths (eg. https://...)
     96 #html_css_files = [
     97 #    'css/custom.css',
     98 #]
     99 
    100 html_logo = "images/gnunet-blue.png"
    101 
    102 # Display to-do items in docs
    103 todo_include_todos = True
    104 
    105 primary_domain = "c"
    106 
    107 highlight_language = "c"
    108 
    109 rst_prolog = f"""
    110 .. role:: c(code)
    111    :language: c
    112 
    113 .. role:: bolditalic
    114    :class: bolditalic
    115 """
    116 
    117 rst_epilog = """
    118 """
    119 
    120