# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# 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('.'))


# -- Project information -----------------------------------------------------

project = 'Survex'
copyright = '1998-2025'
author = ''

# The full version, including alpha/beta/rc tags
release = os.environ.get('VERSION', '')


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

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
]

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

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


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

# 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 = []

# Keep extension compatible with previous docbook manual.
html_file_suffix = '.htm'

html_copy_source = False

highlight_language = 'none'

man_pages = [
    ('aven', 'aven', 'sophisticated cave viewer', '', 1),
    ('cavern', 'cavern', 'process raw survey data', '', 1),
    ('diffpos', 'diffpos', 'compare two processed data files', '', 1),
    ('dump3d', 'dump3d', 'text dump of processed survey data file', '', 1),
    ('extend', 'extend', 'produce an extended elevation', '', 1),
    ('sorterr', 'sorterr', 're-sort .err file by various criteria', '', 1),
    ('survexport', 'survexport', 'convert a processed survey data file to another format', '', 1),
    ('survex', 'survex', 'cave surveying software', '', 7),
]

rst_prolog = """
.. |PKGDOCDIR_EXPANDED| replace:: *%s*
""" % os.environ.get('PKGDOCDIR_EXPANDED', '???')
