# 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('../../cerc_persistence/')) sys.path.append(os.path.abspath("./_ext")) sys.path.append(os.path.abspath("./_static")) sys.path.append(os.path.abspath(".")) from cerc_persistence.version import __version__ sys.setrecursionlimit(1500) # -- Project information ----------------------------------------------------- project = 'CERC persistence reference manual' copyright = '2021, Guille Gutierrez and Pilar Monsalvete' author = 'CERC Next-Generation Cities' # The full version, including alpha/beta/rc tags release = __version__ # -- 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. 'sphinx.ext.autodoc', extensions = [ 'sphinx.ext.autodoc', 'cerc_documenter' ] autodoc_mock_imports = ["pyproj", "sqlalchemy", "hub", "numpy", "trimesh", "Node", "Edge", "pandas", "typing", "xmltodict", "geomeppy", "parseidf", "rhino3dm", "pyecore", "EPackage", "pyecore.ecore", "geopandas", "shapely", "catalog_factories.greenery.greenery_catalog" ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] source_suffix = ['.rst', '.md'] # 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 ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'sphinx_rtd_theme' # 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'] todo_include_todos = True master_doc = 'index' latex_elements = {'extraclassoptions': 'openany,oneside'}