""" Configuration file for the Sphinx documentation builder. Documentation: http://www.sphinx-doc.org/en/master/config """ # -- Imports ----------------------------------------------------------------- import os import time import datetime # -- Project Information ----------------------------------------------------- project = "novelWriter" copyright = f"{datetime.date.today().year}" author = "Veronica Berglyd Olsen" initFile = os.path.join( os.path.dirname(__file__), os.pardir, os.pardir, "novelwriter", "__init__.py" ) with open(initFile) as inFile: for aLine in inFile: if aLine.startswith("__version__"): release = aLine.split('"')[1].strip() break else: release = "unknown" version = release.split("-")[0] # -- General Configuration --------------------------------------------------- os.environ["TZ"] = "Europe/Oslo" time.tzset() needs_sphinx = "5.0" extensions = [] templates_path = ["_templates"] source_suffix = ".rst" master_doc = "index" today_fmt = "%A, %d %B %Y at %H:%M" language = "en" exclude_patterns = [] # -- Options for HTML Output ------------------------------------------------- html_theme = "sphinx_book_theme" html_title = f"Version {release}" html_static_path = ["_static"] html_css_files = ["custom.css"] html_theme_options = { "logo": { "image_light": "_static/novelwriter-light.png", "image_dark": "_static/novelwriter-dark.png", }, "show_toc_level": 2, "show_navbar_depth": 1, "repository_url": "https://github.com/vkbo/novelwriter", "navigation_with_keys": True, "use_repository_button": True, "use_issues_button": True, "pygment_light_style": "tango", "pygment_dark_style": "dracula", } html_sidebars = { "**": ["navbar-logo", "sidebar-title", "sbt-sidebar-nav"], } # -- Options for HTMLHelp Output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = "novelWriterDoc" # -- Options for LaTeX Output ------------------------------------------------ latex_elements = { "papersize": "a4paper", "pointsize": "11pt", "preamble": ( "\\usepackage[utf8]{inputenc}\n" "\\DeclareUnicodeCharacter{2212}{\\textendash}\n" ), "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, "manual.tex", "novelWriter Documentation", author, "manual" )] # -- Options for Man Page Output --------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [( master_doc, "novelwriter", "novelWriter 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, "novelWriter", "novelWriter Documentation", author, "novelWriter", "Markdown-like editor for novels.", "Miscellaneous" )] # -- Options for EPub Output ------------------------------------------------- # Bibliographic Dublin Core info. epub_title = project # A list of files that should not be packed into the epub file. epub_exclude_files = ["search.html"]