# -*- coding: utf-8 -*- # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- 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('.')) needs_sphinx = '1.3' # -- Project information ----------------------------------------------------- project = 'Voxelman' copyright = '2019, Péter Magyar (Relintai)' author = 'Péter Magyar (Relintai)' version = 'latest' release = 'latest' # Parse Sphinx tags passed from RTD via environment env_tags = os.getenv('SPHINX_TAGS') if env_tags != None: for tag in env_tags.split(','): print("Adding Sphinx tag: %s" % tag.strip()) tags.add(tag.strip()) # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. sys.path.append(os.path.abspath('extensions')) extensions = [ 'gdscript', 'sphinx.ext.imgmath' ] # 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 = ['_build', 'Thumbs.db', '.DS_Store'] source_suffix = '.rst' source_encoding = 'utf-8-sig' # GDScript syntax highlighting from gdscript import GDScriptLexer from sphinx.highlighting import lexers lexers['gdscript'] = GDScriptLexer() # Pygments (syntax highlighting) style to use pygments_style = 'sphinx' highlight_language = 'gdscript' # -- Options for HTML output ------------------------------------------------- # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org on_rtd = os.environ.get('READTHEDOCS', None) == 'True' import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] if on_rtd: using_rtd_theme = True # Theme options html_theme_options = { # 'typekit_id': 'hiw1hhg', # 'analytics_id': '', # 'sticky_navigation': True # Set to False to disable the sticky nav while scrolling. 'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text 'collapse_navigation': False, # Collapse navigation (False makes it tree-like) # 'display_version': True, # Display the docs version # 'navigation_depth': 4, # Depth of the headers shown in the navigation bar } # VCS options: https://docs.readthedocs.io/en/latest/vcs.html#github html_context = { "display_github": True, # Integrate GitHub "github_user": "Relintai", # Username "github_repo": "voxelman", # Repo name "github_version": "master", # Version "conf_py_path": "/docs/", # Path in the checkout to the docs root } #html_logo = 'img/docs_logo.png' # 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'] # These paths are either relative to html_static_path # or fully qualified paths (eg. https://...) html_css_files = [ 'css/custom.css', ] # Output file base name for HTML help builder htmlhelp_basename = 'Voxelmandoc' # -- Options for reStructuredText parser ---------------------------------- # Enable directives that insert the contents of external files file_insertion_enabled = False