conf.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# LibreCAD documentation build configuration file, created by
# sphinx-quickstart on Thu Nov  1 16:32:08 2018.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# 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.todo']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md']

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'LibreCAD'
title = 'LibreCAD User Manual'
copyright = '2018-2024, LibreCAD.org'
author = 'LibreCAD Documentation Team'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '2.2.x'
# The full version, including alpha/beta/rc tags.
release = '2.2.x.y'

# 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 = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
##html_theme = 'alabaster'
##html_theme = 'classic'
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
## Options for sphinx_rtd_theme:
#   'canonical_url': '',
#   'analytics_id': 'UA-XXXXXXX-1',  #  Provided by Google in your dashboard
#   'logo_only': False,
#   'display_version': True,
#   'prev_next_buttons_location': 'bottom',
#   'style_external_links': False,
#   'vcs_pageview_mode': '',
#   'style_nav_header_background': 'white',
## ToC options
    'collapse_navigation': True,
    'sticky_navigation': True,
    'navigation_depth': 3,
#   'includehidden': True,
#   'titles_only': False
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']


# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars

##html_sidebars = {
##    '**': [
##        'relations.html',  # needs 'show_related': True theme option to display
##        'searchbox.html',
##    ]
##}

### Theme overrides
## Theme overrides defined in _static/css/theme_overrides.css 
## https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html
def setup(app):
   app.add_css_file("css/theme_overrides.css")
##   app.add_stylesheet('css/theme_overrides.css')
##
## Alternate approaches
##   app.add_css_file('theme_overrides.css')  [app.add_css_file(...) as app. add_stylesheet(...) has been deprecated] <- Doesn't work with RtD(?)
##
## or
##html_style = 'theme_overrides.css'
##
## or
##html_css_files = [
##    'css/theme_overrides.css',
##]


## Added LibreCAD icon
html_logo = 'images/librecad64X64.png'
html_favicon = 'images/icons/librecad.ico'

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'LibreCADdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
      'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
     'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # '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, 'LibreCAD.tex', title, 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, 'librecad', 'LibreCAD User Guide', 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, 'LibreCADUserGuide', title, author, 
    'LibreCAD', 'LibreCAD User Guide.', 'Miscellaneous'),
]


# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

## Image for epub book
epub_cover = ('/images/splash_librecad.png', '')

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']