X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fsource%2Fconf.py;h=40bb70be3b7ef69d3e573fbedf56864cbb162554;hb=HEAD;hp=baf787e31df7d587fe990fb203b81f8777aba941;hpb=3074f78cad49c95a7f808a72403809df4f7edc5b;p=dunshire.git diff --git a/doc/source/conf.py b/doc/source/conf.py index baf787e..40bb70b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -36,26 +36,29 @@ master_doc = 'index' # 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' @@ -70,23 +73,11 @@ todo_include_todos = False # 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. @@ -102,7 +93,12 @@ html_show_sphinx = False 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. @@ -114,14 +110,16 @@ htmlhelp_basename = 'dunshiredoc' # -- 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 --------------------------------------- @@ -129,7 +127,7 @@ latex_documents = [ # 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) ] @@ -143,7 +141,7 @@ man_pages = [ # (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'), ]