# -*- coding: utf-8 -*-1#2# Boolean-Cayley-graphs documentation build configuration file, created by3# sphinx-quickstart on Sun Jun 11 18:47:38 2017.4#5# This file is execfile()d with the current directory set to its6# containing dir.7#8# Note that not all possible configuration values are present in this9# autogenerated file.10#11# All configuration values have a default; values that are commented out12# serve to show the default.1314# If extensions (or modules to document with autodoc) are in another directory,15# add these directories to sys.path here. If the directory is relative to the16# documentation root, use os.path.abspath to make it absolute, like shown here.17#18import os19import sys20sys.path.insert(0, os.path.abspath('..'))21sys.path.insert(0, os.path.abspath('../boolean_cayley_graphs'))22import sage.all2324# -- General configuration ------------------------------------------------2526# If your documentation needs a minimal Sphinx version, state it here.27#28# needs_sphinx = '1.0'2930# Add any Sphinx extension module names here, as strings. They can be31# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom32# ones.33extensions = [34'sphinx.ext.autodoc',35'sphinx.ext.mathjax',36'sphinx.ext.todo',37'sphinx.ext.viewcode',38]3940# Add any paths that contain templates here, relative to this directory.41templates_path = ['_templates']4243# The suffix(es) of source filenames.44# You can specify multiple suffix as a list of string:45#46# source_suffix = ['.rst', '.md']47source_suffix = '.rst'4849# The encoding of source files.50#51# source_encoding = 'utf-8-sig'5253# The master toctree document.54master_doc = 'index'5556# General information about the project.57project = u'Boolean-Cayley-graphs'58copyright = u'2017-2023, Paul Leopardi'59author = u'Paul Leopardi'6061# The version info for the project you're documenting, acts as replacement for62# |version| and |release|, also used in various other places throughout the63# built documents.64#65# The short X.Y version.66try:67version = os.environ["BCG_VERSION"]68except:69version = u'0.0'70# The full version, including alpha/beta/rc tags.71try:72release = os.environ["BCG_RELEASE"]73except:74release = u'0.0.0.0'7576# The language for content autogenerated by Sphinx. Refer to documentation77# for a list of supported languages.78#79# This is also used if you do content translation via gettext catalogs.80# Usually you set "language" from the command line for these cases.81language = 'en'8283# There are two options for replacing |today|: either, you set today to some84# non-false value, then it is used:85#86# today = ''87#88# Else, today_fmt is used as the format for a strftime call.89#90# today_fmt = '%B %d, %Y'9192# List of patterns, relative to source directory, that match files and93# directories to ignore when looking for source files.94# This patterns also effect to html_static_path and html_extra_path95exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']9697# The reST default role (used for this markup: `text`) to use for all98# documents.99#100# default_role = None101102# If true, '()' will be appended to :func: etc. cross-reference text.103#104# add_function_parentheses = True105106# If true, the current module name will be prepended to all description107# unit titles (such as .. function::).108#109# add_module_names = True110111# If true, sectionauthor and moduleauthor directives will be shown in the112# output. They are ignored by default.113#114# show_authors = False115116# The name of the Pygments (syntax highlighting) style to use.117pygments_style = 'sphinx'118119# A list of ignored prefixes for module index sorting.120# modindex_common_prefix = []121122# If true, keep warnings as "system message" paragraphs in the built documents.123# keep_warnings = False124125# If true, `todo` and `todoList` produce output, else they produce nothing.126todo_include_todos = True127128129# -- Options for HTML output ----------------------------------------------130131# The theme to use for HTML and HTML Help pages. See the documentation for132# a list of builtin themes.133#134#html_theme = 'alabaster'135#html_theme = "classic"136html_theme = 'sphinx_rtd_theme'137138# Theme options are theme-specific and customize the look and feel of a theme139# further. For a list of options available for each theme, see the140# documentation.141#142# html_theme_options = {}143144# Add any paths that contain custom themes here, relative to this directory.145html_theme_path = ["themes"]146147# The name for this set of Sphinx documents.148# "<project> v<release> documentation" by default.149#150# html_title = u'Boolean-Cayley-graphs v0.0.0.0'151152# A shorter title for the navigation bar. Default is the same as html_title.153#154# html_short_title = None155156# The name of an image file (relative to this directory) to place at the top157# of the sidebar.158#159# html_logo = None160161# The name of an image file (relative to this directory) to use as a favicon of162# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32163# pixels large.164#165html_favicon = 'tau_3.ico'166167# Add any paths that contain custom static files (such as style sheets) here,168# relative to this directory. They are copied after the builtin static files,169# so a file named "default.css" will overwrite the builtin "default.css".170html_static_path = ['_static']171172# Add any extra paths that contain custom files (such as robots.txt or173# .htaccess) here, relative to this directory. These files are copied174# directly to the root of the documentation.175#176# html_extra_path = []177178# If not None, a 'Last updated on:' timestamp is inserted at every page179# bottom, using the given strftime format.180# The empty string is equivalent to '%b %d, %Y'.181#182# html_last_updated_fmt = None183184# If true, SmartyPants will be used to convert quotes and dashes to185# typographically correct entities.186#187# html_use_smartypants = True188189# Custom sidebar templates, maps document names to template names.190#191# html_sidebars = {}192193# Additional templates that should be rendered to pages, maps page names to194# template names.195#196# html_additional_pages = {}197198# If false, no module index is generated.199#200# html_domain_indices = True201202# If false, no index is generated.203#204# html_use_index = True205206# If true, the index is split into individual pages for each letter.207#208# html_split_index = False209210# If true, links to the reST sources are added to the pages.211#212# html_show_sourcelink = True213214# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.215#216# html_show_sphinx = True217218# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.219#220# html_show_copyright = True221222# If true, an OpenSearch description file will be output, and all pages will223# contain a <link> tag referring to it. The value of this option must be the224# base URL from which the finished HTML is served.225#226# html_use_opensearch = ''227228# This is the file name suffix for HTML files (e.g. ".xhtml").229# html_file_suffix = None230231# Language to be used for generating the HTML full-text search index.232# Sphinx supports the following languages:233# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'234# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'235#236# html_search_language = 'en'237238# A dictionary with options for the search language support, empty by default.239# 'ja' uses this config value.240# 'zh' user can custom change `jieba` dictionary path.241#242# html_search_options = {'type': 'default'}243244# The name of a javascript file (relative to the configuration directory) that245# implements a search results scorer. If empty, the default will be used.246#247# html_search_scorer = 'scorer.js'248249# Output file base name for HTML help builder.250htmlhelp_basename = 'Boolean-Cayley-graphsdoc'251252# -- Options for LaTeX output ---------------------------------------------253254latex_elements = {255# The paper size ('letterpaper' or 'a4paper').256#257# 'papersize': 'letterpaper',258259# The font size ('10pt', '11pt' or '12pt').260#261# 'pointsize': '10pt',262263# Additional stuff for the LaTeX preamble.264#265# 'preamble': '',266267# Latex figure (float) alignment268#269# 'figure_align': 'htbp',270}271272# Grouping the document tree into LaTeX files. List of tuples273# (source start file, target name, title,274# author, documentclass [howto, manual, or own class]).275latex_documents = [276(master_doc, 'Boolean-Cayley-graphs.tex', u'Boolean-Cayley-graphs Documentation',277u'Paul Leopardi', 'manual'),278]279280# The name of an image file (relative to this directory) to place at the top of281# the title page.282#283# latex_logo = None284285# For "manual" documents, if this is true, then toplevel headings are parts,286# not chapters.287#288# latex_use_parts = False289290# If true, show page references after internal links.291#292# latex_show_pagerefs = False293294# If true, show URL addresses after external links.295#296# latex_show_urls = False297298# Documents to append as an appendix to all manuals.299#300# latex_appendices = []301302# If false, no module index is generated.303#304# latex_domain_indices = True305306307# -- Options for manual page output ---------------------------------------308309# One entry per manual page. List of tuples310# (source start file, name, description, authors, manual section).311man_pages = [312(master_doc, 'boolean-cayley-graphs', u'Boolean-Cayley-graphs Documentation',313[author], 1)314]315316# If true, show URL addresses after external links.317#318# man_show_urls = False319320321# -- Options for Texinfo output -------------------------------------------322323# Grouping the document tree into Texinfo files. List of tuples324# (source start file, target name, title, author,325# dir menu entry, description, category)326texinfo_documents = [327(master_doc, 'Boolean-Cayley-graphs', u'Boolean-Cayley-graphs Documentation',328author, 'Boolean-Cayley-graphs', 'One line description of project.',329'Miscellaneous'),330]331332# Documents to append as an appendix to all manuals.333#334# texinfo_appendices = []335336# If false, no module index is generated.337#338# texinfo_domain_indices = True339340# How to display URL addresses: 'footnote', 'no', or 'inline'.341#342# texinfo_show_urls = 'footnote'343344# If true, do not generate a @detailmenu in the "Top" node's menu.345#346# texinfo_no_detailmenu = False347348349# -- Options for Epub output ----------------------------------------------350351# Bibliographic Dublin Core info.352epub_title = project353epub_author = author354epub_publisher = author355epub_copyright = copyright356357# The basename for the epub file. It defaults to the project name.358# epub_basename = project359360# The HTML theme for the epub output. Since the default themes are not361# optimized for small screen space, using the same theme for HTML and epub362# output is usually not wise. This defaults to 'epub', a theme designed to save363# visual space.364#365# epub_theme = 'epub'366367# The language of the text. It defaults to the language option368# or 'en' if the language is not set.369#370# epub_language = ''371372# The scheme of the identifier. Typical schemes are ISBN or URL.373# epub_scheme = ''374375# The unique identifier of the text. This can be a ISBN number376# or the project homepage.377#378# epub_identifier = ''379380# A unique identification for the text.381#382# epub_uid = ''383384# A tuple containing the cover image and cover page html template filenames.385#386# epub_cover = ()387388# A sequence of (type, uri, title) tuples for the guide element of content.opf.389#390# epub_guide = ()391392# HTML files that should be inserted before the pages created by sphinx.393# The format is a list of tuples containing the path and title.394#395# epub_pre_files = []396397# HTML files that should be inserted after the pages created by sphinx.398# The format is a list of tuples containing the path and title.399#400# epub_post_files = []401402# A list of files that should not be packed into the epub file.403epub_exclude_files = ['search.html']404405# The depth of the table of contents in toc.ncx.406#407# epub_tocdepth = 3408409# Allow duplicate toc entries.410#411# epub_tocdup = True412413# Choose between 'default' and 'includehidden'.414#415# epub_tocscope = 'default'416417# Fix unsupported image types using the Pillow.418#419# epub_fix_images = False420421# Scale large images.422#423# epub_max_image_width = 0424425# How to display URL addresses: 'footnote', 'no', or 'inline'.426#427# epub_show_urls = 'inline'428429# If false, no index is generated.430#431# epub_use_index = True432433434