conf.py

###############################################################
# Copyright 2020 Lawrence Livermore National Security, LLC
# (c.f. AUTHORS, NOTICE.LLNS, COPYING)
#
# This file is part of the Flux resource manager framework.
# For details, see https://github.com/flux-framework.
#
# SPDX-License-Identifier: LGPL-3.0
###############################################################

# 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 = 'Flux'
copyright = '''Copyright 2014 Lawrence Livermore National Security, LLC and Flux developers.

SPDX-License-Identifier: LGPL-3.0'''
author = 'This page is maintained by the Flux community.'

# -- 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.intersphinx',
    'sphinxcontrib.spelling',
]

# sphinxcontrib.spelling settings
spelling_word_list_filename = [
    'spell.en.pws'
]

# 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', 'README.md']

master_doc = 'index'
source_suffix = '.rst'

linkcheck_ignore = [
    r'https://blog\.x\.com/.*', # 403 Forbidden, Cloudflare bot challenge
    r'https://www\.freedesktop\.org/.*', # 418 Client Error: I'm a teapot
]

linkcheck_anchors_ignore_for_url = [
    r'https://github\.com/.*',
]

linkcheck_request_headers = {
    'https://www.mcs.anl.gov/': {
        'User-Agent': 'python-requests'
    },
    'https://www.gnu.org/': {
        'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:141.0) Gecko/20100101 '
                      'Firefox/141.0' # Spoof Firefox
    },
    '*': {
        'Accept': '*/*',
    }
}


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

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

# -- Options for man output -------------------------------------------------

man_pages = [
]


# -- Per-file smart quotes -------------------------------------------------
# A document may disable smart quotes by starting with the file-wide
# metadata field ':smartquotes: false', e.g. for literal JSON in tables.

from docutils import nodes
from sphinx.transforms import SphinxTransform


class FileSmartQuotes(SphinxTransform):
    default_priority = 700  # after DocInfo (340), before SmartQuotes (750)

    def apply(self, **kwargs):
        for docinfo in self.document.findall(nodes.docinfo):
            for field in docinfo.findall(nodes.field):
                name = field[0].astext().strip().lower()
                value = field[1].astext().strip().lower()
                if name == 'smartquotes' and value in ('false', 'no', 'off'):
                    self.document.settings.smart_quotes = False


def setup(app):
    app.add_transform(FileSmartQuotes)