1# Configuration file for the Sphinx documentation builder.
2#
3# This file only contains a selection of the most common options. For a full
4# list see the documentation:
5# https://www.sphinx-doc.org/en/master/usage/configuration.html
6
7# -- Path setup --------------------------------------------------------------
8
9# If extensions (or modules to document with autodoc) are in another directory,
10# add these directories to sys.path here. If the directory is relative to the
11# documentation root, use os.path.abspath to make it absolute, like shown here.
12#
13import os
14import sys
15import platform
16
17system = platform.system().lower()
18machine = platform.machine()
19pymajor, pyminor, _ = platform.python_version_tuple()
20libpath = f'../../build/lib.{system}-{machine}-{pymajor}.{pyminor}'
21sys.path.insert(0, os.path.abspath(libpath))
22
23import pynauty
24
25# -- Project information -----------------------------------------------------
26
27project = 'Pynauty'
28copyright = '2021, Peter Dobsan'
29author = 'Peter Dobsan'
30
31version = pynauty.__version__
32release = pynauty.__version__
33
34html_title = project
35
36
37# -- General configuration ---------------------------------------------------
38
39# Add any Sphinx extension module names here, as strings. They can be
40# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
41# ones.
42extensions = [
43        'sphinx.ext.viewcode',
44        'sphinx.ext.autodoc',
45        'sphinx.ext.intersphinx',
46        'sphinx.ext.mathjax',
47]
48
49# Add any paths that contain templates here, relative to this directory.
50#templates_path = ['_templates']
51
52# List of patterns, relative to source directory, that match files and
53# directories to ignore when looking for source files.
54# This pattern also affects html_static_path and html_extra_path.
55exclude_patterns = []
56
57
58# -- Options for HTML output -------------------------------------------------
59
60# The theme to use for HTML and HTML Help pages.  See the documentation for
61# a list of builtin themes.
62#
63html_theme = 'classic'
64
65html_theme_options = {
66        #'rightsidebar': 'true',
67        'stickysidebar': 'true',
68}
69
70
71# Add any paths that contain custom static files (such as style sheets) here,
72# relative to this directory. They are copied after the builtin static files,
73# so a file named "default.css" will overwrite the builtin "default.css".
74#html_static_path = ['_static']
75