conf.py

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, 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('.'))
from sphinx.builders.html import StandaloneHTMLBuilder
import subprocess, os, sys
from pathlib import Path
sys.path.insert(0, os.path.abspath('.'))
sys.path.append(str(Path('_ext').resolve()))

# Doxygen
subprocess.call('doxygen Doxyfile', shell=True)

# -- Project information -----------------------------------------------------
#
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'CGNS'
author = ''

# -- General configuration ---------------------------------------------------
#
# https://www.sphinx-doc.org/en/master/usage/configuration.html#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 = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.autosectionlabel',
    'sphinx.ext.todo',
    'sphinx.ext.extlinks',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx_sitemap',
    'sphinx.ext.inheritance_diagram',
    'sphinxfortran.fortran_domain',
    'sphinxfortran.fortran_autodoc',
    'breathe',
    'cgns_function_summary'
]
# Prefix to add to ticket numbers to get the full URL to JIRA
# see use in the News page
extlinks = {
    'issue': ('https://cgnsorg.atlassian.net/projects/CGNS/issues/%s', '#%s'),
    'version': ('https://github.com/CGNS/CGNS/releases/tag/%s', 'version%s')}

#suppress_warnings = [ 'image.not_readable' ]
suppress_warnings = ['autosectionlabel.*']

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

highlight_language = 'c'
pygments_style = 'sphinx'

# adding Lexer
from sphinx.highlighting import lexers
import sys
sys.path.append('.')
from sidslexer import SidsLexer

lexers["sids"] = SidsLexer()

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_book_theme"

html_context = {
   "default_mode": "light",
   "default_theme": "light"
}

# Options for HTML output
html_title = "CGNS Documentation"
html_baseurl = "https://cgns.org"
html_logo = "_static/CGNS_logo_nobckgrnd.svg"
#html_favicon = "assets/img/favicon.ico"
#html_last_updated_fmt = ""

# 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"]

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = ["css/custom.css", 'css/filemap.css']
html_theme_options = {
    "repository_url": "https://github.com/CGNS/cgns-modern.github.io",
    "use_issues_button": True,
    "use_edit_page_button": False,
    "use_download_button": False,
    "use_fullscreen_button": True,
    "use_repository_button": True,
    "extra_footer": 'Dedicated to the public domain with <a href="https://creativecommons.org/publicdomain/zero/1.0/" class="reference external">CC0 1.0</a>.',
#    "show_navbar_depth": 1,
#    "toc_title": "Sections",
    "icon_links": [
        {
            "name": "GitHub",
            "url": "https://github.com/CGNS/CGNS",
            "icon": "fa-solid fa-download",
        },
    ],
}

#fortran_src = ["../src/c.F90"]
#fortran_subsection_type = "title"
# -- Breathe configuration -------------------------------------------------

breathe_projects = {
        "CGNS Sphinx Doxygen Breathe": "./xml"
}
#breathe_implementation_filename_extensions = ['.c']
breathe_domain_by_extension = {"h" : "c"}
breathe_default_project = "CGNS Sphinx Doxygen Breathe"
breathe_default_members = ('members', 'undoc-members')