You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
95 lines
3.1 KiB
95 lines
3.1 KiB
# 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('.'))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import sys
|
|
|
|
import minigrid
|
|
|
|
project = "MiniGrid"
|
|
copyright = "2023 Farama Foundation"
|
|
author = "Farama Foundation"
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = minigrid.__version__
|
|
|
|
sys.path.insert(0, os.path.abspath("../.."))
|
|
|
|
# -- 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.
|
|
extensions = [
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.doctest",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.githubpages",
|
|
"sphinx.ext.viewcode",
|
|
"myst_parser",
|
|
"sphinx_github_changelog",
|
|
]
|
|
|
|
source_suffix = {
|
|
".rst": "restructuredtext",
|
|
".md": "markdown",
|
|
}
|
|
|
|
# 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 = []
|
|
|
|
# Napoleon settings
|
|
napoleon_use_ivar = True
|
|
napoleon_use_admonition_for_references = True
|
|
# See https://github.com/sphinx-doc/sphinx/issues/9119
|
|
napoleon_custom_sections = [("Returns", "params_style")]
|
|
|
|
# -- 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 = "MiniGrid Documentation"
|
|
html_baseurl = "https://minigrid.farama.org/"
|
|
html_copy_source = False
|
|
html_favicon = "_static/img/minigrid-favicon.png"
|
|
html_theme_options = {
|
|
"light_logo": "img/minigrid.svg",
|
|
"dark_logo": "img/minigrid-white.svg",
|
|
"image": "img/minigrid-github.png",
|
|
"description": "Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid.",
|
|
"gtag": "G-FBXJQQLXKD",
|
|
"versioning": True,
|
|
"source_repository": "https://github.com/Farama-Foundation/Minigrid/",
|
|
"source_branch": "master",
|
|
"source_directory": "docs/",
|
|
}
|
|
|
|
html_static_path = ["_static"]
|
|
html_css_files = []
|
|
|
|
# -- Generate Changelog -------------------------------------------------
|
|
|
|
sphinx_github_changelog_token = os.environ.get("SPHINX_GITHUB_CHANGELOG_TOKEN")
|