# -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # import os import sys sys.path.insert(0, os.path.abspath('../..')) # -- Project information ----------------------------------------------------- project = 'Reticulum Network Stack' copyright = '2023, Mark Qvist' author = 'Mark Qvist' exec(open("../../RNS/_version.py").read()) version = __version__ # The full version, including alpha/beta/rc tags import RNS release = f"{RNS._version.__version__} beta" # -- General configuration --------------------------------------------------- extensions = [ "sphinx.ext.autodoc", "sphinx_copybutton", ] autodoc_member_order = "bysource" toc_object_entries_show_parents = "hide" autodoc_preserve_defaults = True # add_module_names = False # latex_toplevel_sectioning = 'section' # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- html_show_sphinx = True html_theme = "furo" html_logo = "graphics/rns_logo_512.png" html_theme_options = { "top_of_page_button": None, # "footer_icons": [ # { # "name": "GitHub", # "url": "https://github.com/markqvist/reticulum", # "html": """ # # # # """, # "class": "", # }, # ], "dark_css_variables": { "color-background-primary": "#202b38", "color-background-secondary": "#161f27", "color-foreground-primary": "#dbdbdb", "color-foreground-secondary": "#a9b1ba", "color-brand-primary": "#41adff", "color-background-hover": "#161f27", "color-api-name": "#ffbe85", "color-api-pre-name": "#efae75", }, # "announcement": "Announcement content", } html_static_path = ["_static"] html_css_files = [ 'custom.css', ] # html_theme = "pydata_sphinx_theme" # html_theme_options = { # "navbar_start": ["navbar-logo"], # "navbar_center": ["navbar-nav"], # "navbar_end": ["navbar-icon-links"], # "navbar_align": "left", # "left_sidebar_end": [], # "show_nav_level": 5, # "navigation_depth": 5, # "collapse_navigation": True, # } # html_sidebars = { # "**": ["sidebar-nav-bs"] # } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". # def check_skip_member(app, what, name, obj, skip, options): # print(what, " | ", name, " | ", obj, " | ", skip, " | ", options) # return False # def setup(app): # app.connect('autodoc-skip-member', check_skip_member)