# 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.
-sys.path.insert(0, os.path.abspath('../../src/'))
-sys.path.insert(0, os.path.abspath('../../src/dunshire'))
+sys.path.insert(0, os.path.abspath('../../'))
# 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.doctest',
+ 'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
- 'sphinx.ext.pngmath',
'sphinx.ext.viewcode',
]
-autosummary_generate = True
-
# Don't automatically test every >>> block in the documentation. This
# avoids testing the API docs as part of the documentation build,
# which is exactly what we intend, because those are tested as part of
# General information about the project.
project = 'Dunshire'
-copyright = '2016, Michael Orlitzky'
+copyright = '2024, Michael Orlitzky'
author = 'Michael Orlitzky'
# The short X.Y version.
-version = '0.0.1'
+version = '0.1.3'
# The full version, including alpha/beta/rc tags.
-release = '0.0.1'
+release = '0.1.3'
# 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 = None
+language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
+# Don't show "dunshire.games" before every damned method.
+add_module_names = False
+
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'alabaster'
-
-# Remove the search box from the default list of sidebars.
-html_sidebars = {
- '**': [
- 'about.html',
- 'navigation.html'
- ]
-}
+html_theme = 'haiku'
-# http://alabaster.readthedocs.io/en/latest/customization.html#theme-options
-html_theme_options = {
- 'github_button': False,
- 'github_user': False,
- 'github_repo': False,
- 'show_powered_by': False
-}
+# https://www.sphinx-doc.org/en/master/usage/theming.html
+#html_theme_options = {
+#}
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_show_copyright = False
# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# Warning: regardless of the suffix, sphinx will generate html5.
+#html_file_suffix = ".xhtml"
+
+# Don't include the restructured text source files for the XHTML
+# pages, and don't display a link to them either.
+html_show_sourcelink = False
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
+ 'preamble' : r'\usepackage{amsfonts,amssymb}',
+ 'printindex' : ''
}
# 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, 'dunshire.tex', 'Dunshire Documentation',
- 'author', 'manual'),
+ (master_doc, 'dunshire.tex', project + ' Documentation',
+ author, '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, 'Dunshire', 'Dunshire Documentation',
+ (master_doc, project, project + ' Documentation',
[author], 1)
]
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'Dunshire', 'Dunshire Documentation',
+ (master_doc, project, project + ' Documentation',
author, 'derp', 'One line description of project.',
'Miscellaneous'),
]