#
# 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
sys.path.insert(0, os.path.abspath('../'))


# -- Project information -----------------------------------------------------

project = 'PythonRobotics'
copyright = '2018-2021, Atsushi Sakai'
author = 'Atsushi Sakai'

# The short X.Y version
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 = [
 'matplotlib.sphinxext.plot_directive',
 'sphinx.ext.autodoc',
 'sphinx.ext.mathjax',
 'sphinx.ext.viewcode',
 'sphinx.ext.napoleon',
 'sphinx.ext.imgconverter',
 'IPython.sphinxext.ipython_console_highlighting',
 'sphinx_copybutton',
 'sphinx_rtd_dark_mode',
]

# 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 = '_main.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'


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
# Fix for read the docs
on_rtd = os.environ.get('READTHEDOCS') == 'True'
if on_rtd:
 html_theme = 'default'
else:
 html_theme = 'sphinx_rtd_light_them'

# 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_logo = '../icon.png'
html_theme_options = {
 'display_version': False,
}

# replace "view page source" with "edit on github" in Read The Docs theme
# * https://github.com/readthedocs/sphinx_rtd_theme/issues/529
html_context = {
 'display_github': True,
 'github_user': 'AtsushiSakai',
 'github_repo': 'PythonRobotics',
 'github_version': 'master',
 "conf_py_path": "/docs/",
 "source_suffix": source_suffix,
}

# 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_css_files = ['custom.css']

# 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 = 'PythonRoboticsdoc'


# -- 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, 'PythonRobotics.tex', 'PythonRobotics Documentation',
 'Atsushi Sakai', '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, 'pythonrobotics', 'PythonRobotics 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, 'PythonRobotics', 'PythonRobotics Documentation',
 author, 'PythonRobotics', 'One line description of project.',
 'Miscellaneous'),
]


# -- Extension configuration -------------------------------------------------