# # 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/master/config # -- 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 # import sphinx_bootstrap_theme sys.path.insert(0, os.path.abspath("../")) import momepy # noqa # autodoc_mock_imports = [ # "geopandas", # "networkx", # "numpy", # "pandas", # "rtree", # "scipy", # "scipy.spatial", # "shapely", # "shapely.geometry", # "shapely.wkt", # "shapely.ops", # "libpysal", # "tqdm", # "mapclassify", # "osmnx", # "inequality", # ] # -- Project information ----------------------------------------------------- project = "momepy" copyright = "2018-, Martin Fleischmann and PySAL Developers" # noqa: A001 author = "Martin Fleischmann" # The short X.Y version version = momepy.__version__ # The full version, including alpha/beta/rc tags release = version # -- 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.autosummary", "sphinx.ext.linkcode", "sphinxcontrib.bibtex", "sphinx.ext.mathjax", "sphinx.ext.doctest", "sphinx.ext.intersphinx", "numpydoc", "nbsphinx", "matplotlib.sphinxext.plot_directive", "IPython.sphinxext.ipython_console_highlighting", "myst_parser", "sphinx_copybutton", "sphinx_gallery.load_style", ] # nbsphinx do not use requirejs (breaks bootstrap) nbsphinx_requirejs_path = "" # 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 = "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 = ["_build", "Thumbs.db", ".DS_Store"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" # path to bib file with references bibtex_bibfiles = ["_static/references.bib"] bibtex_reference_style = "author_year" # -- 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' # html_theme = "pydata_sphinx_theme" # html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() # 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 = { # "github_url": "https://github.com/pysal/momepy", # "twitter_url": "https://twitter.com/martinfleis", # "pygment_light_style": "tango", # "logo": { # "image_light": "horizontal_logo_light.svg", # "image_dark": "horizontal_logo_dark.svg", # }, #} # 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"] html_favicon = "_static/favicon.png" def setup(app): app.add_css_file("custom.css") # also can be a full URL # 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 = "momepydoc" # -- Options for LaTeX output ------------------------------------------------ latex_elements = { # 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, "momepy.tex", "momepy Documentation", "Martin Fleischmann", "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, "momepy", "momepy 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, "momepy", "momepy Documentation", author, "momepy", "One line description of project.", "Miscellaneous", ) ] # -- Options for Epub output ------------------------------------------------- # Bibliographic Dublin Core info. epub_title = project # The unique identifier of the text. This can be a ISBN number # or the project homepage. # # epub_identifier = '' # A unique identification for the text. # # epub_uid = '' # A list of files that should not be packed into the epub file. epub_exclude_files = ["search.html"] # Add redirect for previously existing pages, # each item is like `(from_old, to_new)` rediraffe_redirects = { "user_guide/elements/preprocessing.ipynb": "user_guide/preprocessing/simple_preprocessing.ipynb", # noqa: E501 } # -- Extension configuration ------------------------------------------------- intersphinx_mapping = { "libpysal": ( "https://pysal.org/libpysal/", "https://pysal.org/libpysal//objects.inv", ), } # Generate the API documentation when building autosummary_generate = True autosummary_imported_members = True numpydoc_show_class_members = True class_members_toctree = True numpydoc_show_inherited_class_members = True numpydoc_class_members_toctree = False numpydoc_use_plots = True autodoc_typehints = "none" nbsphinx_prolog = r""" {% set docname = env.doc2path(env.docname, base=None) %} .. only:: html .. role:: raw-html(raw) :format: html .. note:: | This page was generated from `{{ docname }}`__. | Interactive online version: :raw-html:`Binder badge` __ https://github.com/pysal/momepy/blob/master/docs/{{ docname }} """ # noqa: E501 def linkcode_resolve(domain, info): def find_source(): # try to find the file and line number, based on code from numpy: # https://github.com/numpy/numpy/blob/master/doc/source/conf.py#L286 obj = sys.modules[info["module"]] for part in info["fullname"].split("."): obj = getattr(obj, part) import inspect import os fn = inspect.getsourcefile(obj) fn = os.path.relpath(fn, start=os.path.dirname(momepy.__file__)) source, lineno = inspect.getsourcelines(obj) return fn, lineno, lineno + len(source) - 1 if domain != "py" or not info["module"]: return None try: filename = "momepy/%s#L%d-L%d" % find_source() except Exception: filename = info["module"].replace(".", "/") + ".py" tag = "main" if "+" in release else ("v" + release) return f"https://github.com/pysal/momepy/blob/{tag}/{filename}" # Define the canonical URL if you are using a custom domain on Read the Docs html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") # Tell Jinja2 templates the build is running on Read the Docs if os.environ.get("READTHEDOCS", "") == "True": if "html_context" not in globals(): html_context = {} html_context["READTHEDOCS"] = True