#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# dune documentation build configuration file, created by
# sphinx-quickstart on Tue Apr 11 21:24:42 2017.
#
# 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.append(os.path.abspath('exts'))

from sphinx.highlighting import lexers
from dune_lexer import DuneLexer
from opam_lexer import OpamLexer
from cram_lexer import CramLexer

lexers[DuneLexer.name] = DuneLexer(startinline=True)
lexers[OpamLexer.name] = OpamLexer()
lexers[CramLexer.name] = CramLexer()

from pathlib import Path
import re

# Read constant from a file
version_file = Path(__file__).parent.parent / "otherlibs/dune-rpc/types.ml"
text = version_file.read_text()

match = re.search(r"\s*let\s+latest\s*=\s*(\d+),\s*(\d+)", text)
if not match:
    raise RuntimeError("Could not find latest version in " + version_file)

major, minor = match.groups()
LATEST = f"{major}.{minor}"

from sphinx.application import Sphinx

def replace_substitutions(app, docname, source):
    src = source[0]
    source[0] = src.replace("{{latest}}", app.config.latest)

def setup(app: Sphinx):
    app.add_config_value("latest", LATEST, "env")
    app.connect("source-read", replace_substitutions)

# -- 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_copybutton',
    'sphinx_design',
    'myst_parser',
]

myst_enable_extensions = ["colon_fence"]

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

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'Dune'
copyright = u'2017 - 2025, Jérémie Dimino & the Dune maintainers'
author = u'Jérémie Dimino & the Dune maintainers'

# 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',
    'dev',
    'papers',
    'changes',
]

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

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

# 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 = {
    "top_of_page_buttons": ["edit", "view"],

    "source_repository": "https://github.com/ocaml/dune/",
    "source_branch": "main",
    "source_directory": "doc/",
}

# 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']
html_css_files = [
    'css/custom.css'
]


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

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


# -- 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, 'dune.tex', 'Dune Documentation',
     u'Jérémie Dimino', '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, 'dune', 'Dune 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, 'dune', 'Dune Documentation',
     author, 'dune', 'One line description of project.',
     'Miscellaneous'),
]
