# -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list see the documentation: # http://www.sphinx-doc.org/en/stable/config import os from typing import Dict, List import m2r2 import viser # -- 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. # # -- Project information ----------------------------------------------------- project = "viser" copyright = "2024" author = "brentyi" version: str = os.environ.get("VISER_VERSION_STR_OVERRIDE", viser.__version__) # Formatting! # 0.1.30 => v0.1.30 # dev => dev if not version.isalpha(): version = "v" + version # The full version, including alpha/beta/rc tags release = "" # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ "sphinx.ext.autodoc", "sphinx.ext.todo", "sphinx.ext.coverage", "sphinx.ext.mathjax", "sphinx.ext.githubpages", "sphinx.ext.napoleon", # "sphinx.ext.inheritance_diagram", "sphinx.ext.viewcode", "m2r2", "sphinxcontrib.programoutput", "sphinxcontrib.ansi", "sphinxcontrib.googleanalytics", # google analytics extension https://github.com/sphinx-contrib/googleanalytics/tree/master ] programoutput_use_ansi = True html_ansi_stylesheet = "black-on-white.css" html_static_path = ["_static"] html_theme_options = { "light_css_variables": { "color-code-background": "#f4f4f4", "color-code-foreground": "#000", }, "footer_icons": [ { "name": "GitHub", "url": "https://github.com/nerfstudio-project/viser", "html": """ """, "class": "", }, ], "light_logo": "logo.svg", "dark_logo": "logo.svg", } # Pull documentation types from hints autodoc_typehints = "both" autodoc_class_signature = "separated" autodoc_default_options = { "members": True, "member-order": "bysource", "undoc-members": True, "inherited-members": True, "exclude-members": "__init__, __post_init__", "imported-members": True, } # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = [".rst", ".md"] # source_suffix = ".rst" # The master toctree document. master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language: str = "en" # 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: List[str] = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "monokai" # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "furo" html_title = "viser" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # # html_theme_options = {} # 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". # html_static_path = ["_static"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # # html_sidebars = {} # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = "viser_doc" # -- Options for Github output ------------------------------------------------ sphinx_to_github = True sphinx_to_github_verbose = True sphinx_to_github_encoding = "utf-8" # -- Options for LaTeX output ------------------------------------------------ latex_elements: Dict[str, str] = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ( master_doc, "viser.tex", "viser", "brentyi", "manual", ), ] # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [(master_doc, "viser", "viser documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ( master_doc, "viser", "viser", author, "viser", "viser", "Miscellaneous", ), ] # -- Extension configuration -------------------------------------------------- # Google Analytics ID googleanalytics_id = "G-RRGY51J5ZH" # -- Options for todo extension ---------------------------------------------- # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True # -- Enable Markdown -> RST conversion ---------------------------------------- def docstring(app, what, name, obj, options, lines): md = "\n".join(lines) rst = m2r2.convert(md) lines.clear() lines += rst.splitlines() def setup(app): app.connect("autodoc-process-docstring", docstring) app.add_css_file("css/custom.css") # -- Napoleon settings ------------------------------------------------------- # Settings for parsing non-sphinx style docstrings. We use Google style in this # project. napoleon_google_docstring = True napoleon_numpy_docstring = False napoleon_include_init_with_doc = False napoleon_include_private_with_doc = False napoleon_include_special_with_doc = True napoleon_use_admonition_for_examples = False napoleon_use_admonition_for_notes = False napoleon_use_admonition_for_references = False napoleon_use_ivar = False napoleon_use_param = True napoleon_use_rtype = True napoleon_preprocess_types = True napoleon_type_aliases = None napoleon_attr_annotations = True