From bf4f5195d4e6e6528b733cfc12d078e31e68399c Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Thu, 12 Oct 2023 17:42:03 +0000 Subject: [PATCH 001/238] test: Add initial testing Ads basic testing structure with positive tests. The initial tests only check if building the documentation succeeeds. --- .pre-commit-config.yaml | 4 +- justfile | 3 + pyproject.toml | 12 ++++ requirements.txt | 20 +++++- tests/sites/pass/minimal/conf.py | 2 + tests/sites/pass/minimal_legacy/conf.py | 7 ++ .../templates/minimal/.sphinx/_toc.yml.in | 3 + tests/sites/templates/minimal/a.md | 1 + tests/sites/templates/minimal/index.md | 1 + tests/test_sites.py | 68 +++++++++++++++++++ 10 files changed, 118 insertions(+), 3 deletions(-) create mode 100644 tests/sites/pass/minimal/conf.py create mode 100644 tests/sites/pass/minimal_legacy/conf.py create mode 100644 tests/sites/templates/minimal/.sphinx/_toc.yml.in create mode 100644 tests/sites/templates/minimal/a.md create mode 100644 tests/sites/templates/minimal/index.md create mode 100644 tests/test_sites.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 816e35e1..87100e5b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -25,13 +25,13 @@ repos: entry: just mypy types_or: [python, pyi] language: system - exclude: ^docs/.* + exclude: ^docs/|^tests/(sites|templates) - id: ruff name: ruff entry: just ruff types_or: [python, pyi] language: system - exclude: ^docs/.* + exclude: ^docs/|^tests/(sites|templates) require_serial: true - id: isort name: isort diff --git a/justfile b/justfile index 657b1a3c..8c8c403c 100644 --- a/justfile +++ b/justfile @@ -93,6 +93,9 @@ docs: {{python}} -m sphinx -j auto -T -b html -d docs/_build/doctrees \ --color -D language=en docs docs/_build/html +test +files="tests": + {{python}} -m pytest {{files}} + _check-commit-mesg file: {{python}} -m commitizen check --allow-abort --commit-msg-file {{file}} diff --git a/pyproject.toml b/pyproject.toml index 021585b2..77eee8e9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -53,6 +53,7 @@ development = [ "pip-tools>=6.13.0", "pre-commit>=3.3.2", "ruff>=0.0.269", + "pytest>=7.4.2" ] [project.entry-points."sphinx.html_themes"] @@ -96,6 +97,7 @@ check_untyped_defs = true color_output = true disallow_any_generics = true disallow_incomplete_defs = true +exclude = ["^docs", "^tests/(sites|templates)"] implicit_reexport = false pretty = true python_version = 3.8 @@ -115,5 +117,15 @@ warn_unused_ignores = true [tool.ruff] select = ["ARG", "F", "E", "W", "N", "D", "UP", "RET"] ignore = ["E501", "D203", "D213", "D4"] +exclude = ["tests/sites", "tests/templates"] target-version = "py38" line-length = 80 + +[tool.ruff.per-file-ignores] +"tests/test_*.py" = ["D"] + +[tool.pytest.ini_options] +markers = [ + "for_all_folders: perform multiple calls based on test folders", + "template_folder: use the folder as a template to copy data over it" +] diff --git a/requirements.txt b/requirements.txt index f181d679..5551d743 100644 --- a/requirements.txt +++ b/requirements.txt @@ -65,6 +65,8 @@ docutils==0.19 # sphinx doxysphinx==3.3.4 # via rocm-docs-core (pyproject.toml) +exceptiongroup==1.1.3 + # via pytest fastjsonschema==2.18.1 # via rocm-docs-core (pyproject.toml) filelock==3.12.4 @@ -81,10 +83,13 @@ imagesize==1.4.1 # via sphinx importlib-metadata==6.8.0 # via + # build # commitizen # sphinx importlib-resources==5.12.0 ; python_version < "3.9" # via rocm-docs-core (pyproject.toml) +iniconfig==2.0.0 + # via pytest isort==5.12.0 # via rocm-docs-core (pyproject.toml) jinja2==3.1.2 @@ -124,6 +129,7 @@ packaging==23.2 # build # commitizen # pydata-sphinx-theme + # pytest # sphinx pathspec==0.11.2 # via black @@ -133,6 +139,8 @@ platformdirs==3.11.0 # via # black # virtualenv +pluggy==1.3.0 + # via pytest pre-commit==3.4.0 # via rocm-docs-core (pyproject.toml) prompt-toolkit==3.0.39 @@ -161,6 +169,10 @@ pyparsing==3.1.1 # via doxysphinx pyproject-hooks==1.0.0 # via build +pytest==7.4.2 + # via rocm-docs-core (pyproject.toml) +python-dateutil==2.8.2 + # via pygithub pytz==2023.3.post1 # via babel pyyaml==6.0.1 @@ -178,6 +190,8 @@ requests==2.31.0 # sphinx ruff==0.0.292 # via rocm-docs-core (pyproject.toml) +six==1.16.0 + # via python-dateutil smmap==5.0.1 # via gitdb snowballstemmer==2.2.0 @@ -226,6 +240,7 @@ tomli==2.0.1 # mypy # pip-tools # pyproject-hooks + # pytest tomlkit==0.12.1 # via commitizen tqdm==4.66.1 @@ -236,8 +251,11 @@ typing-extensions==4.8.0 # filelock # mypy # pydata-sphinx-theme + # pygithub urllib3==2.0.6 - # via requests + # via + # pygithub + # requests virtualenv==20.24.5 # via pre-commit wcwidth==0.2.8 diff --git a/tests/sites/pass/minimal/conf.py b/tests/sites/pass/minimal/conf.py new file mode 100644 index 00000000..f6fb06bf --- /dev/null +++ b/tests/sites/pass/minimal/conf.py @@ -0,0 +1,2 @@ +html_theme = "rocm_docs_theme" +extensions = ["rocm_docs"] diff --git a/tests/sites/pass/minimal_legacy/conf.py b/tests/sites/pass/minimal_legacy/conf.py new file mode 100644 index 00000000..15e38996 --- /dev/null +++ b/tests/sites/pass/minimal_legacy/conf.py @@ -0,0 +1,7 @@ +from rocm_docs import ROCmDocs + +docs_core = ROCmDocs("ROCm Docs Core") +docs_core.setup() + +for sphinx_var in ROCmDocs.SPHINX_VARS: + globals()[sphinx_var] = getattr(docs_core, sphinx_var) diff --git a/tests/sites/templates/minimal/.sphinx/_toc.yml.in b/tests/sites/templates/minimal/.sphinx/_toc.yml.in new file mode 100644 index 00000000..ab8e7b56 --- /dev/null +++ b/tests/sites/templates/minimal/.sphinx/_toc.yml.in @@ -0,0 +1,3 @@ +root: index.md +entries: + - file: a.md diff --git a/tests/sites/templates/minimal/a.md b/tests/sites/templates/minimal/a.md new file mode 100644 index 00000000..00666208 --- /dev/null +++ b/tests/sites/templates/minimal/a.md @@ -0,0 +1 @@ +# A subdocument diff --git a/tests/sites/templates/minimal/index.md b/tests/sites/templates/minimal/index.md new file mode 100644 index 00000000..bf7e3cb8 --- /dev/null +++ b/tests/sites/templates/minimal/index.md @@ -0,0 +1 @@ +# rocm-docs core test site diff --git a/tests/test_sites.py b/tests/test_sites.py new file mode 100644 index 00000000..24158de0 --- /dev/null +++ b/tests/test_sites.py @@ -0,0 +1,68 @@ +from typing import Any, Callable, Dict, Generator + +import shutil +from pathlib import Path + +import pytest +from sphinx.testing.path import path as sphinx_test_path +from sphinx.testing.util import SphinxTestApp + +pytest_plugins = ["sphinx.testing.fixtures"] + +SITES_BASEFOLDER = Path(__file__).parent / "sites" +TEMPLATE_FOLDER = SITES_BASEFOLDER / "templates" / "minimal" + + +@pytest.fixture() +def with_no_git_repo(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setenv("ROCM_DOCS_REMOTE_DETAILS", ",") + + +@pytest.fixture() +def build_factory( + request: pytest.FixtureRequest, + make_app: Callable[..., SphinxTestApp], + tmp_path: Path, + with_no_git_repo: None, # noqa: ARG001 +) -> Generator[Callable[..., SphinxTestApp], None, None]: + src_folder = request.param + + def make(**kwargs: Dict[Any, Any]) -> SphinxTestApp: + srcdir = tmp_path.joinpath(src_folder) + srcdir.parent.mkdir(parents=True, exist_ok=True) + + mark = request.node.get_closest_marker("template_folder") + if mark is not None: + shutil.copytree(mark.args[0], srcdir) + + shutil.copytree( + SITES_BASEFOLDER / src_folder, srcdir, dirs_exist_ok=True + ) + return make_app(srcdir=sphinx_test_path(srcdir), **kwargs) + + yield make + + +def pytest_generate_tests(metafunc: pytest.Metafunc) -> None: + mark = metafunc.definition.get_closest_marker("for_all_folders") + if mark is not None and "build_factory" in metafunc.fixturenames: + + def folder_id(p: Path) -> str: + return str(p.relative_to(mark.args[0])) + + metafunc.parametrize( + "build_factory", + map( + lambda x: x.relative_to(SITES_BASEFOLDER), + SITES_BASEFOLDER.joinpath(mark.args[0]).iterdir(), + ), + ids=folder_id, + indirect=True, + ) + + +@pytest.mark.for_all_folders("pass") +@pytest.mark.template_folder(TEMPLATE_FOLDER) +def test_pass(build_factory: Callable[..., SphinxTestApp]) -> None: + app = build_factory() + app.build() From f1c9c5d3e9f28de71b902b5d81f516e58dd47252 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Thu, 12 Oct 2023 17:45:24 +0000 Subject: [PATCH 002/238] ci: Enable testing in CI --- .github/workflows/pull_request.yml | 41 ++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 2478e811..b481e80d 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -1,10 +1,10 @@ -name: Code Linting +name: Code on: pull_request: jobs: lint: - name: Python + name: Python Linting strategy: matrix: os: ["ubuntu-latest", "windows-latest"] @@ -47,3 +47,40 @@ jobs: run: just _check-commit-range "refs/remotes/origin/${{ github.base_ref }}..HEAD" - name: Check linting, formatting, types run: just --set verbose_errors true -- check-codestyle + + test: + name: Python Tests + strategy: + fail-fast: true + matrix: + os: ["ubuntu-latest", "windows-latest"] + python-version: ["3.8"] + + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v3.5.0 + with: + fetch-depth: 0 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "${{ matrix.python-version }}" + cache: pip + cache-dependency-path: | + pyproject.toml + requirements.txt + - name: Cache venv + uses: actions/cache@v3.3.1 + with: + path: .venv + key: venv-${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml','requirements.txt') }} + - name: Install just + uses: extractions/setup-just@v1 + with: + just-version: '1.13.0' + - name: Create virtual env, install requirements + run: just deps + - name: Install + run: just install + - name: Run tests + run: just test From fc81d384705b2e3bd8f2b638c054acb70524d164 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Thu, 12 Oct 2023 17:45:45 +0000 Subject: [PATCH 003/238] style: Run linting/formatting/type-checking on tests too --- justfile | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/justfile b/justfile index 8c8c403c..ee8c10ea 100644 --- a/justfile +++ b/justfile @@ -47,24 +47,24 @@ build: _format extra_args +files: {{python}} -m black --config pyproject.toml {{extra_args}} {{files}} -format +files="src docs": (_format "" files) -check-format +files="src docs": (_format "--check" files) +format +files="src tests docs": (_format "" files) +check-format +files="src tests docs": (_format "--check" files) _isort extra_args +files: {{python}} -m isort --settings-path pyproject.toml {{extra_args}} {{files}} # Sort imports -isort +files="src docs": (_isort "" files) +isort +files="src tests docs": (_isort "" files) # Check if imports are correctly sorted -check-isort +files="src docs": (_isort "--check" files) +check-isort +files="src tests docs": (_isort "--check" files) _ruff extra_args +files: {{ruff_exe}} --config pyproject.toml {{extra_args}} {{files}} # Run ruff to lint files -ruff +files="src": (_ruff "" files) +ruff +files="src tests": (_ruff "" files) # Run ruff and autolint -fix-ruff +files="src": (_ruff "--fix --exit-non-zero-on-fix" files) +fix-ruff +files="src tests": (_ruff "--fix --exit-non-zero-on-fix" files) _run-hook hook: @{{python}} -m pre_commit run --all-files {{ if verbose_errors == "true" {"--show-diff-on-failure"} else {""} }} {{hook}} @@ -73,20 +73,20 @@ _run-hook hook: hooks: (_run-hook "check-yaml") (_run-hook "check-json") (_run-hook "check-toml") (_run-hook "end-of-file-fixer") (_run-hook "file-contents-sorter") (_run-hook "trailing-whitespace") # Run linters, no files are modified -lint +files="src": (ruff "" files) hooks +lint +files="src tests": (ruff "" files) hooks # Run linters, trying to fix errors automatically -fix-lint +files="src": (fix-ruff files) hooks +fix-lint +files="src tests": (fix-ruff files) hooks # Run type-checking -mypy +files="src": +mypy +files="src tests": {{python}} -m mypy --config-file pyproject.toml {{files}} # Run formatting, linters, imports sorting, fixing errors if possible -fix-codestyle +files="src": (fix-lint files) (isort files) (format files) +fix-codestyle +files="src tests": (fix-lint files) (isort files) (format files) alias codestyle := fix-codestyle # Check formatting, linters, imports sorting -check-codestyle +files="src": (lint files) (check-isort files) (check-format files) (mypy files) +check-codestyle +files="src tests": (lint files) (check-isort files) (check-format files) (mypy files) alias check := check-codestyle docs: From bad076642d31e3974e0aef344a8530a583a0816f Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Fri, 13 Oct 2023 12:43:00 +0000 Subject: [PATCH 004/238] test: Enable the testing of doctest string --- justfile | 2 +- pyproject.toml | 1 + requirements.txt | 1 - 3 files changed, 2 insertions(+), 2 deletions(-) diff --git a/justfile b/justfile index ee8c10ea..6a59cbbc 100644 --- a/justfile +++ b/justfile @@ -93,7 +93,7 @@ docs: {{python}} -m sphinx -j auto -T -b html -d docs/_build/doctrees \ --color -D language=en docs docs/_build/html -test +files="tests": +test +files="src tests": {{python}} -m pytest {{files}} _check-commit-mesg file: diff --git a/pyproject.toml b/pyproject.toml index 77eee8e9..16393111 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -129,3 +129,4 @@ markers = [ "for_all_folders: perform multiple calls based on test folders", "template_folder: use the folder as a template to copy data over it" ] +addopts = ["--doctest-modules", "--ignore=tests/sites"] diff --git a/requirements.txt b/requirements.txt index 5551d743..9a59f1b9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -248,7 +248,6 @@ tqdm==4.66.1 typing-extensions==4.8.0 # via # black - # filelock # mypy # pydata-sphinx-theme # pygithub From 74a72cb314965cca959632a3c5ff0d39429b6d43 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Fri, 13 Oct 2023 12:47:52 +0000 Subject: [PATCH 005/238] test: Factor out test helpers to separate files, speed up tests Add separate helpers for common loggin and sphinx testing utilities. Mock external projects to not fetch remote files during testing which speeds the tests up. --- tests/__init__.py | 1 + tests/conftest.py | 6 ++ tests/logging.py | 70 ++++++++++++++++ tests/sites/pass/minimal/conf.py | 2 + tests/sites/pass/minimal_legacy/conf.py | 2 + .../templates/minimal/.sphinx/_toc.yml.in | 6 +- tests/sphinx.py | 83 +++++++++++++++++++ tests/test_sites.py | 50 ++++------- 8 files changed, 185 insertions(+), 35 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/logging.py create mode 100644 tests/sphinx.py diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 00000000..16ce89d7 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +"""Test utilities""" diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 00000000..55f45766 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,6 @@ +"""Pytest Configuration""" + +from .logging import * # noqa: F403 +from .sphinx import * # noqa: F403 + +pytest_plugins = ["sphinx.testing.fixtures"] diff --git a/tests/logging.py b/tests/logging.py new file mode 100644 index 00000000..a0d380ea --- /dev/null +++ b/tests/logging.py @@ -0,0 +1,70 @@ +"""Defines Helpers for capturing and working with logs in tests""" + +from typing import Any, Callable, Generator, Iterable, List, Set + +import logging +import unittest.mock + +import pytest + + +class AddLogHandlerFixture: + """Fixture for registering delayed handlers for logs""" + + def __init__(self, caplog: pytest.LogCaptureFixture) -> None: + """Initialize the fixture""" + self.caplog = caplog + self._handlers: List[Callable[[Iterable[logging.LogRecord]], None]] = [] + + def __call__( + self, handler: Callable[[Iterable[logging.LogRecord]], None] + ) -> Any: + """Register a handler""" + self._handlers.append(handler) + + def run_handlers(self) -> None: + """Run all previously registered handlers""" + for handler in self._handlers: + handler(self.caplog.get_records("call")) + + +@pytest.fixture() +def add_log_handler( + caplog: pytest.LogCaptureFixture, + with_sphinx_logs: None, # noqa: ARG001 +) -> Generator[AddLogHandlerFixture, None, None]: + """Factory for registering delayed log handlers""" + fixture = AddLogHandlerFixture(caplog) + yield fixture + fixture.run_handlers() + + +@pytest.fixture() +def expected_logs() -> Set[logging.LogRecord]: + """The set of expected logs, see no_unexpected_logs""" + return set() + + +@pytest.fixture() +def no_unexpected_logs( + add_log_handler: AddLogHandlerFixture, expected_logs: Set[logging.LogRecord] +) -> None: + """Raise an error if an unexpected log is found + + all expected warnings should be added to `expected_logs` + """ + + def validate_logs(records: Iterable[logging.LogRecord]) -> None: + for record in records: + if record.levelno < logging.WARNING: + continue + if record not in expected_logs: + pytest.fail(f"Unexpected log: {record.getMessage()}") + + add_log_handler(validate_logs) + + +@pytest.fixture() +def with_sphinx_logs(monkeypatch: pytest.MonkeyPatch) -> None: + """Fixture to enable capturing sphinx logs in pytest""" + monkeypatch.setattr("sphinx.util.logging.setup", unittest.mock.Mock()) diff --git a/tests/sites/pass/minimal/conf.py b/tests/sites/pass/minimal/conf.py index f6fb06bf..bc844490 100644 --- a/tests/sites/pass/minimal/conf.py +++ b/tests/sites/pass/minimal/conf.py @@ -1,2 +1,4 @@ html_theme = "rocm_docs_theme" extensions = ["rocm_docs"] + +external_projects_current_project = "a" diff --git a/tests/sites/pass/minimal_legacy/conf.py b/tests/sites/pass/minimal_legacy/conf.py index 15e38996..93fe3d40 100644 --- a/tests/sites/pass/minimal_legacy/conf.py +++ b/tests/sites/pass/minimal_legacy/conf.py @@ -5,3 +5,5 @@ for sphinx_var in ROCmDocs.SPHINX_VARS: globals()[sphinx_var] = getattr(docs_core, sphinx_var) + +external_projects_current_project = "a" diff --git a/tests/sites/templates/minimal/.sphinx/_toc.yml.in b/tests/sites/templates/minimal/.sphinx/_toc.yml.in index ab8e7b56..88577608 100644 --- a/tests/sites/templates/minimal/.sphinx/_toc.yml.in +++ b/tests/sites/templates/minimal/.sphinx/_toc.yml.in @@ -1,3 +1,7 @@ root: index.md entries: - - file: a.md + - file: a.md + - title: External Project A + url: ${project:a} + - title: Externale Project B + url: ${project:b} diff --git a/tests/sphinx.py b/tests/sphinx.py new file mode 100644 index 00000000..4540175f --- /dev/null +++ b/tests/sphinx.py @@ -0,0 +1,83 @@ +"""Defines helpers for testing the rocm_docs sphinx extension""" + +from typing import Any, Callable, Dict, Generator, Iterable, Set + +import dataclasses +import functools +import logging +import shutil +from pathlib import Path + +import pytest +from sphinx.testing.path import path as sphinx_test_path +from sphinx.testing.util import SphinxTestApp + +from .logging import AddLogHandlerFixture + + +@dataclasses.dataclass +class WithNoGitRepoFixture: + """Type return from with_no_git_repo fixture""" + + _expected_logs: Set[logging.LogRecord] + log_not_found_ok: bool = False + + def validate_logs(self, records: Iterable[logging.LogRecord]) -> None: + """Validate that a warning is logged for not being in a repo""" + for record in records: + if ( + record.getMessage() + == "Not in a Git Directory, disabling repository buttons" + ): + self._expected_logs.add(record) + return + if self.log_not_found_ok: + return + + pytest.fail("Did not find git warning log") + + +@pytest.fixture() +def with_no_git_repo( + monkeypatch: pytest.MonkeyPatch, + expected_logs: Set[logging.LogRecord], + add_log_handler: AddLogHandlerFixture, +) -> WithNoGitRepoFixture: + """Setup environment to allow testing outside a git repository""" + monkeypatch.setenv("ROCM_DOCS_REMOTE_DETAILS", ",") + + fixt = WithNoGitRepoFixture(expected_logs) + add_log_handler(fixt.validate_logs) + return fixt + + +SITES_BASEFOLDER = Path(__file__).parent / "sites" +TEMPLATE_FOLDER = SITES_BASEFOLDER / "templates" / "minimal" + + +@pytest.fixture() +def build_factory( + request: pytest.FixtureRequest, + make_app: Callable[..., SphinxTestApp], + tmp_path: Path, + with_no_git_repo: WithNoGitRepoFixture, # noqa: ARG001, +) -> Generator[Callable[..., SphinxTestApp], None, None]: + """A factory to make Sphinx test applications""" + + def make(src_folder: Path, /, **kwargs: Dict[Any, Any]) -> SphinxTestApp: + srcdir = tmp_path.joinpath(src_folder) + srcdir.parent.mkdir(parents=True, exist_ok=True) + + mark = request.node.get_closest_marker("template_folder") + if mark is not None: + shutil.copytree(mark.args[0], srcdir) + + shutil.copytree( + SITES_BASEFOLDER / src_folder, srcdir, dirs_exist_ok=True + ) + return make_app(srcdir=sphinx_test_path(srcdir), **kwargs) + + if hasattr(request, "param"): + yield functools.partial(make, request.param) + else: + yield make diff --git a/tests/test_sites.py b/tests/test_sites.py index 24158de0..4101d7df 100644 --- a/tests/test_sites.py +++ b/tests/test_sites.py @@ -1,46 +1,24 @@ -from typing import Any, Callable, Dict, Generator +from typing import Callable -import shutil from pathlib import Path import pytest -from sphinx.testing.path import path as sphinx_test_path from sphinx.testing.util import SphinxTestApp -pytest_plugins = ["sphinx.testing.fixtures"] +import rocm_docs.projects -SITES_BASEFOLDER = Path(__file__).parent / "sites" -TEMPLATE_FOLDER = SITES_BASEFOLDER / "templates" / "minimal" +from .sphinx import SITES_BASEFOLDER, TEMPLATE_FOLDER @pytest.fixture() -def with_no_git_repo(monkeypatch: pytest.MonkeyPatch) -> None: - monkeypatch.setenv("ROCM_DOCS_REMOTE_DETAILS", ",") - - -@pytest.fixture() -def build_factory( - request: pytest.FixtureRequest, - make_app: Callable[..., SphinxTestApp], - tmp_path: Path, - with_no_git_repo: None, # noqa: ARG001 -) -> Generator[Callable[..., SphinxTestApp], None, None]: - src_folder = request.param - - def make(**kwargs: Dict[Any, Any]) -> SphinxTestApp: - srcdir = tmp_path.joinpath(src_folder) - srcdir.parent.mkdir(parents=True, exist_ok=True) - - mark = request.node.get_closest_marker("template_folder") - if mark is not None: - shutil.copytree(mark.args[0], srcdir) - - shutil.copytree( - SITES_BASEFOLDER / src_folder, srcdir, dirs_exist_ok=True - ) - return make_app(srcdir=sphinx_test_path(srcdir), **kwargs) - - yield make +def mocked_projects(monkeypatch: pytest.MonkeyPatch) -> None: + monkeypatch.setattr( + "rocm_docs.projects._load_projects", + lambda *_, **__: { + "a": rocm_docs.projects._Project("https://example.com/a", [], ""), + "b": rocm_docs.projects._Project("https://example.com/b", [], ""), + }, + ) def pytest_generate_tests(metafunc: pytest.Metafunc) -> None: @@ -63,6 +41,10 @@ def folder_id(p: Path) -> str: @pytest.mark.for_all_folders("pass") @pytest.mark.template_folder(TEMPLATE_FOLDER) -def test_pass(build_factory: Callable[..., SphinxTestApp]) -> None: +def test_pass( + mocked_projects: None, # noqa: ARG001 + build_factory: Callable[..., SphinxTestApp], + no_unexpected_logs: None, # noqa: ARG001 +) -> None: app = build_factory() app.build() From 2d2cbe3a233786b1bbca9dad97b3c21ddef6dedf Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Fri, 13 Oct 2023 13:31:25 +0000 Subject: [PATCH 006/238] test: Filter deprecation warnings from external modules in tests --- pyproject.toml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 16393111..35d9a55a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -130,3 +130,11 @@ markers = [ "template_folder: use the folder as a template to copy data over it" ] addopts = ["--doctest-modules", "--ignore=tests/sites"] +filterwarnings = """ +ignore::DeprecationWarning +default::DeprecationWarning:rocm_docs +default::PendingDeprecationWarning:rocm_docs +ignore::PendingDeprecationWarning +default::DeprecationWarning:tests +default::DeprecationWarning:rocm_docs +""" From 29d350bbf0a4597024c8cd311925ac3509151997 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Mon, 16 Oct 2023 09:34:09 +0000 Subject: [PATCH 007/238] test: refactor log and sphinx testing fixtures Make a scoped log assertion fixture, allows to check from logs from a bounded range. Rewrite unexpected/expected log and sphinx helpers using this utility. Add tests for these utilities. --- pyproject.toml | 4 +- tests/conftest.py | 4 +- tests/log_fixtures.py | 282 ++++++++++++++++++++++++ tests/logging.py | 70 ------ tests/{sphinx.py => sphinx_fixtures.py} | 51 ++--- tests/test_meta.py | 44 ++++ tests/test_sites.py | 27 ++- 7 files changed, 364 insertions(+), 118 deletions(-) create mode 100644 tests/log_fixtures.py delete mode 100644 tests/logging.py rename tests/{sphinx.py => sphinx_fixtures.py} (54%) create mode 100644 tests/test_meta.py diff --git a/pyproject.toml b/pyproject.toml index 35d9a55a..0a3328d6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -122,12 +122,14 @@ target-version = "py38" line-length = 80 [tool.ruff.per-file-ignores] +"tests/conftest.py" = ["F401", "F403"] "tests/test_*.py" = ["D"] [tool.pytest.ini_options] markers = [ "for_all_folders: perform multiple calls based on test folders", - "template_folder: use the folder as a template to copy data over it" + "template_folder: use the folder as a template to copy data over it", + "meta_invert_fixture: invert the meaning of the fixture for testing" ] addopts = ["--doctest-modules", "--ignore=tests/sites"] filterwarnings = """ diff --git a/tests/conftest.py b/tests/conftest.py index 55f45766..d4aad717 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,6 +1,6 @@ """Pytest Configuration""" -from .logging import * # noqa: F403 -from .sphinx import * # noqa: F403 +from .log_fixtures import * +from .sphinx_fixtures import * pytest_plugins = ["sphinx.testing.fixtures"] diff --git a/tests/log_fixtures.py b/tests/log_fixtures.py new file mode 100644 index 00000000..ffd213bd --- /dev/null +++ b/tests/log_fixtures.py @@ -0,0 +1,282 @@ +"""Defines Helpers for capturing and working with logs in tests""" + +from __future__ import annotations + +import types +from typing import Callable, Iterable, Iterator, Literal, NamedTuple + +import contextlib +import copy +import itertools +import logging +import unittest.mock + +import pytest + +TestPhase = Literal["setup", "call", "teardown"] + + +class LogHandlerStackToken(NamedTuple): + when: TestPhase + stacklevel: int + + +class LogStackFixture: + def __init__(self, caplog: pytest.LogCaptureFixture): + self._caplog: pytest.LogCaptureFixture = caplog + self._log_stack: list[list[logging.LogRecord]] = [] + + def push(self, *, when: TestPhase = "call") -> LogHandlerStackToken: + # This should be a single atomic operation + records = self._caplog.get_records(when) + if len(records) > 0: + self._log_stack.append(copy.copy(records)) + self._caplog.clear() + return LogHandlerStackToken(when, len(self._log_stack)) + + def pop(self, token: LogHandlerStackToken) -> Iterable[logging.LogRecord]: + return itertools.chain( + *self._log_stack[token.stacklevel :], + self._caplog.get_records(token.when), + ) + + class Scope: + def __init__( + self, + fixture: LogStackFixture, + token: LogHandlerStackToken, + callbacks: contextlib.ExitStack, + ) -> None: + self._fixture = fixture + self._token = token + self._callbacks = callbacks + + def add( + self, callback: Callable[[Iterable[logging.LogRecord]], None] + ) -> None: + self._callbacks.callback( + lambda: callback(self._fixture.pop(self._token)) + ) + + def pop_all(self) -> LogStackFixture.Scope: + return LogStackFixture.Scope( + self._fixture, self._token, self._callbacks.pop_all() + ) + + def close(self) -> None: + self._callbacks.close() + + def __enter__(self) -> LogStackFixture.Scope: + return self + + def __exit__( + self, + type: type, + value: BaseException, + traceback: types.TracebackType, + ) -> bool: + return self._callbacks.__exit__(type, value, traceback) + + def new_scope(self, *, when: TestPhase = "call") -> Scope: + return self.Scope(self, self.push(when=when), contextlib.ExitStack()) + + +@pytest.fixture() +def log_handler_stack( + caplog: pytest.LogCaptureFixture, _with_sphinx_logs: None +) -> LogStackFixture: + """A fixture allowing scoped log handling""" + return LogStackFixture(caplog) + + +@pytest.fixture() +def expected_logs_impl() -> set[logging.LogRecord]: + """Implementation of expected_logs""" + return set() + + +@pytest.fixture() +def _no_unexpected_warnings_impl( + request: pytest.FixtureRequest, + log_handler_stack: LogStackFixture, + expected_logs_impl: set[logging.LogRecord], +) -> Iterator[None]: + if "_no_unexpected_warnings" not in request.fixturenames: + yield + return + + class Validator: + def __init__(self) -> None: + self.logrecord: tuple[str, str, str] | None = None + + def validate(self, records: Iterable[logging.LogRecord]) -> None: + for r in records: + if r.levelno < logging.WARNING: + continue + if r not in expected_logs_impl: + self.logrecord = ( + r.name, + logging.getLevelName(r.levelname), + r.getMessage(), + ) + return + + validator = Validator() + with log_handler_stack.new_scope() as scope: + scope.add(validator.validate) + yield + + invert = request.node.get_closest_marker("meta_invert_fixture") is not None + if validator.logrecord is None: + if not invert: + return + + pytest.fail("Did not find any unexpected logs") + + if not invert: + pytest.fail(f"Unexpected log: {validator.logrecord}") + + +# Must request no_unexpected_warnings_ to ensure its teardown runs *after* +# other fixtures that request expected_logs +@pytest.fixture() +def expected_logs( + _no_unexpected_warnings_impl: None, + expected_logs_impl: set[logging.LogRecord], +) -> set[logging.LogRecord]: + """The set of expected logs, see no_unexpected_warnings""" + return expected_logs_impl + + +@pytest.fixture() +def _no_unexpected_warnings( + _no_unexpected_warnings_impl: None, +) -> None: + """Raise an error if an unexpected log is found + + all expected warnings should be added to `expected_logs` + """ + return + + +class ExpectLogFixture: + """Fixture class for expect_log""" + + def __init__( + self, + log_handler_stack: LogStackFixture, + expected_logs: set[logging.LogRecord], + ) -> None: + """Initialize the fixture""" + self._log_handler_stack = log_handler_stack + self._expected_logs = expected_logs + + class Validator: + def __init__( + self, + scope: LogStackFixture.Scope, + expected: tuple[str, int, str], + *, + required: bool, + capture_all: bool, + expected_logs: set[logging.LogRecord], + ) -> None: + self._scope = scope + self._expected = expected + self._expected_logs = expected_logs + self.required = required + self.capture_all = capture_all + self._found = False + + self._scope.add(self._validate_logs) + + @property + def found(self) -> bool: + return self._found + + def __enter__(self) -> ExpectLogFixture.Validator: + self._scope.__enter__() + return self + + def __exit__( + self, + type: type, + value: BaseException, + traceback: types.TracebackType, + ) -> bool: + return self._scope.__exit__(type, value, traceback) + + def _validate_logs( + self, + records: Iterable[logging.LogRecord], + ) -> None: + self._found = False + for r in records: + if self._expected != (r.name, r.levelno, r.getMessage()): + continue + + self._found = True + self._expected_logs.add(r) + if not self.capture_all: + return + + if not self.required or self._found: + return + + lvl = logging.getLevelName(self._expected[1]) + pytest.fail( + f"Expected log {(self._expected[0], lvl, self._expected[2])}, but it wasn't found" + ) + + def __call__( + self, + name: str, + level: str, + msg: str, + *, + required: bool = True, + capture_all: bool = False, + when: TestPhase = "call", + ) -> ExpectLogFixture.Validator: + """Register a new handler. See expect_log for more details""" + levelno = logging.getLevelName(level) + if not isinstance(levelno, int): + raise ValueError(f'Unkown log level "{level}"') + + return self.Validator( + self._log_handler_stack.new_scope(when=when), + (name, levelno, msg), + required=required, + capture_all=capture_all, + expected_logs=self._expected_logs, + ) + + +@pytest.fixture() +def expect_log( + log_handler_stack: LogStackFixture, expected_logs: set[logging.LogRecord] +) -> ExpectLogFixture: + """Register a verifier for a log message + + Each call to expect_log(name, level, msg) will verify that such a log is + emitted at least once. This log will not trigger unkown warning checks. + Set capture_all to True to capture all warnings that match, not just the first. + """ + return ExpectLogFixture(log_handler_stack, expected_logs) + + +@pytest.fixture() +def _with_sphinx_logs(monkeypatch: pytest.MonkeyPatch) -> None: + """Fixture to enable capturing sphinx logs in pytest""" + monkeypatch.setattr("sphinx.util.logging.setup", unittest.mock.Mock()) + + +__all__ = [ + "_no_unexpected_warnings_impl", + "_no_unexpected_warnings", + "_with_sphinx_logs", + "expect_log", + "expected_logs_impl", + "expected_logs", + "log_handler_stack", +] diff --git a/tests/logging.py b/tests/logging.py deleted file mode 100644 index a0d380ea..00000000 --- a/tests/logging.py +++ /dev/null @@ -1,70 +0,0 @@ -"""Defines Helpers for capturing and working with logs in tests""" - -from typing import Any, Callable, Generator, Iterable, List, Set - -import logging -import unittest.mock - -import pytest - - -class AddLogHandlerFixture: - """Fixture for registering delayed handlers for logs""" - - def __init__(self, caplog: pytest.LogCaptureFixture) -> None: - """Initialize the fixture""" - self.caplog = caplog - self._handlers: List[Callable[[Iterable[logging.LogRecord]], None]] = [] - - def __call__( - self, handler: Callable[[Iterable[logging.LogRecord]], None] - ) -> Any: - """Register a handler""" - self._handlers.append(handler) - - def run_handlers(self) -> None: - """Run all previously registered handlers""" - for handler in self._handlers: - handler(self.caplog.get_records("call")) - - -@pytest.fixture() -def add_log_handler( - caplog: pytest.LogCaptureFixture, - with_sphinx_logs: None, # noqa: ARG001 -) -> Generator[AddLogHandlerFixture, None, None]: - """Factory for registering delayed log handlers""" - fixture = AddLogHandlerFixture(caplog) - yield fixture - fixture.run_handlers() - - -@pytest.fixture() -def expected_logs() -> Set[logging.LogRecord]: - """The set of expected logs, see no_unexpected_logs""" - return set() - - -@pytest.fixture() -def no_unexpected_logs( - add_log_handler: AddLogHandlerFixture, expected_logs: Set[logging.LogRecord] -) -> None: - """Raise an error if an unexpected log is found - - all expected warnings should be added to `expected_logs` - """ - - def validate_logs(records: Iterable[logging.LogRecord]) -> None: - for record in records: - if record.levelno < logging.WARNING: - continue - if record not in expected_logs: - pytest.fail(f"Unexpected log: {record.getMessage()}") - - add_log_handler(validate_logs) - - -@pytest.fixture() -def with_sphinx_logs(monkeypatch: pytest.MonkeyPatch) -> None: - """Fixture to enable capturing sphinx logs in pytest""" - monkeypatch.setattr("sphinx.util.logging.setup", unittest.mock.Mock()) diff --git a/tests/sphinx.py b/tests/sphinx_fixtures.py similarity index 54% rename from tests/sphinx.py rename to tests/sphinx_fixtures.py index 4540175f..9b27b2d9 100644 --- a/tests/sphinx.py +++ b/tests/sphinx_fixtures.py @@ -1,10 +1,10 @@ """Defines helpers for testing the rocm_docs sphinx extension""" -from typing import Any, Callable, Dict, Generator, Iterable, Set +from __future__ import annotations + +from typing import Any, Callable, Generator, Iterator -import dataclasses import functools -import logging import shutil from pathlib import Path @@ -12,43 +12,23 @@ from sphinx.testing.path import path as sphinx_test_path from sphinx.testing.util import SphinxTestApp -from .logging import AddLogHandlerFixture - - -@dataclasses.dataclass -class WithNoGitRepoFixture: - """Type return from with_no_git_repo fixture""" - - _expected_logs: Set[logging.LogRecord] - log_not_found_ok: bool = False - - def validate_logs(self, records: Iterable[logging.LogRecord]) -> None: - """Validate that a warning is logged for not being in a repo""" - for record in records: - if ( - record.getMessage() - == "Not in a Git Directory, disabling repository buttons" - ): - self._expected_logs.add(record) - return - if self.log_not_found_ok: - return - - pytest.fail("Did not find git warning log") +from .log_fixtures import ExpectLogFixture @pytest.fixture() def with_no_git_repo( monkeypatch: pytest.MonkeyPatch, - expected_logs: Set[logging.LogRecord], - add_log_handler: AddLogHandlerFixture, -) -> WithNoGitRepoFixture: + expect_log: ExpectLogFixture, +) -> Iterator[ExpectLogFixture.Validator]: """Setup environment to allow testing outside a git repository""" monkeypatch.setenv("ROCM_DOCS_REMOTE_DETAILS", ",") - fixt = WithNoGitRepoFixture(expected_logs) - add_log_handler(fixt.validate_logs) - return fixt + with expect_log( + "sphinx.rocm_docs.theme", + "WARNING", + "Not in a Git Directory, disabling repository buttons", + ) as validator: + yield validator SITES_BASEFOLDER = Path(__file__).parent / "sites" @@ -60,11 +40,11 @@ def build_factory( request: pytest.FixtureRequest, make_app: Callable[..., SphinxTestApp], tmp_path: Path, - with_no_git_repo: WithNoGitRepoFixture, # noqa: ARG001, + with_no_git_repo: ExpectLogFixture.Validator, # noqa: ARG001, ) -> Generator[Callable[..., SphinxTestApp], None, None]: """A factory to make Sphinx test applications""" - def make(src_folder: Path, /, **kwargs: Dict[Any, Any]) -> SphinxTestApp: + def make(src_folder: Path, /, **kwargs: dict[Any, Any]) -> SphinxTestApp: srcdir = tmp_path.joinpath(src_folder) srcdir.parent.mkdir(parents=True, exist_ok=True) @@ -81,3 +61,6 @@ def make(src_folder: Path, /, **kwargs: Dict[Any, Any]) -> SphinxTestApp: yield functools.partial(make, request.param) else: yield make + + +__all__ = ["with_no_git_repo", "build_factory"] diff --git a/tests/test_meta.py b/tests/test_meta.py new file mode 100644 index 00000000..c5cafd48 --- /dev/null +++ b/tests/test_meta.py @@ -0,0 +1,44 @@ +from __future__ import annotations + +import logging + +import pytest + +from .log_fixtures import ExpectLogFixture + +logger = logging.getLogger(__name__) + + +def test_log_stack(expect_log: ExpectLogFixture) -> None: + with expect_log(logger.name, "WARNING", "Foo"): + logger.warning("Foo") + with expect_log(logger.name, "WARNING", "Bar"): + logger.warning("Bar") + with expect_log(logger.name, "ERROR", "Baz"): + logger.error("Baz") + with expect_log(logger.name, "ERROR", "Qux"): + logger.error("Qux") + + +def test_scope_of_log_stack(expect_log: ExpectLogFixture) -> None: + logger.info("Foo") + with expect_log(logger.name, "INFO", "Foo", required=False) as res: + pass + logger.info("Foo") + assert not res.found + + +@pytest.mark.usefixtures("_no_unexpected_warnings") +@pytest.mark.meta_invert_fixture() +def test_unexpected_warnings() -> None: + logger.warning("An unexpected warning") + + +@pytest.mark.usefixtures("_no_unexpected_warnings") +def test_expected_warning( + caplog: pytest.LogCaptureFixture, expected_logs: set[logging.LogRecord] +) -> None: + logger.warning("An expected warning") + records = caplog.get_records("call") + assert len(records) == 1 + expected_logs.add(records[0]) diff --git a/tests/test_sites.py b/tests/test_sites.py index 4101d7df..fd193d85 100644 --- a/tests/test_sites.py +++ b/tests/test_sites.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from typing import Callable from pathlib import Path @@ -7,18 +9,22 @@ import rocm_docs.projects -from .sphinx import SITES_BASEFOLDER, TEMPLATE_FOLDER +from .sphinx_fixtures import SITES_BASEFOLDER, TEMPLATE_FOLDER @pytest.fixture() -def mocked_projects(monkeypatch: pytest.MonkeyPatch) -> None: +def mocked_projects( + monkeypatch: pytest.MonkeyPatch, +) -> dict[str, rocm_docs.projects._Project]: + projects = { + "a": rocm_docs.projects._Project("https://example.com/a", [], ""), + "b": rocm_docs.projects._Project("https://example.com/b", [], ""), + } monkeypatch.setattr( "rocm_docs.projects._load_projects", - lambda *_, **__: { - "a": rocm_docs.projects._Project("https://example.com/a", [], ""), - "b": rocm_docs.projects._Project("https://example.com/b", [], ""), - }, + lambda *_, **__: projects, ) + return projects def pytest_generate_tests(metafunc: pytest.Metafunc) -> None: @@ -30,9 +36,9 @@ def folder_id(p: Path) -> str: metafunc.parametrize( "build_factory", - map( - lambda x: x.relative_to(SITES_BASEFOLDER), - SITES_BASEFOLDER.joinpath(mark.args[0]).iterdir(), + ( + x.relative_to(SITES_BASEFOLDER) + for x in SITES_BASEFOLDER.joinpath(mark.args[0]).iterdir() ), ids=folder_id, indirect=True, @@ -41,10 +47,9 @@ def folder_id(p: Path) -> str: @pytest.mark.for_all_folders("pass") @pytest.mark.template_folder(TEMPLATE_FOLDER) +@pytest.mark.usefixtures("_no_unexpected_warnings", "mocked_projects") def test_pass( - mocked_projects: None, # noqa: ARG001 build_factory: Callable[..., SphinxTestApp], - no_unexpected_logs: None, # noqa: ARG001 ) -> None: app = build_factory() app.build() From a479598d5a5247a5d3beb48f23a56ad519e148c8 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Tue, 17 Oct 2023 07:12:49 +0000 Subject: [PATCH 008/238] ci: Enable integrated testing UI in vscode for our python tests --- .vscode/settings.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 7da38b1a..8e3d175e 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -9,5 +9,11 @@ ], "editor.rulers": [ 80 - ] + ], + "python.testing.pytestArgs": [ + "src", + "tests" + ], + "python.testing.unittestEnabled": false, + "python.testing.pytestEnabled": true } From 3adab2f9285b4844a3273615526ad7b23faf5ad8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 17 Oct 2023 07:58:23 +0000 Subject: [PATCH 009/238] build(deps): bump pre-commit from 3.4.0 to 3.5.0 Bumps [pre-commit](https://github.com/pre-commit/pre-commit) from 3.4.0 to 3.5.0. - [Release notes](https://github.com/pre-commit/pre-commit/releases) - [Changelog](https://github.com/pre-commit/pre-commit/blob/main/CHANGELOG.md) - [Commits](https://github.com/pre-commit/pre-commit/compare/v3.4.0...v3.5.0) --- updated-dependencies: - dependency-name: pre-commit dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 9a59f1b9..b03a0e28 100644 --- a/requirements.txt +++ b/requirements.txt @@ -141,7 +141,7 @@ platformdirs==3.11.0 # virtualenv pluggy==1.3.0 # via pytest -pre-commit==3.4.0 +pre-commit==3.5.0 # via rocm-docs-core (pyproject.toml) prompt-toolkit==3.0.39 # via questionary From 2469bb22882b85bd45c775dc914463db1f1e7438 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 17 Oct 2023 07:58:39 +0000 Subject: [PATCH 010/238] build(deps): bump doxysphinx from 3.3.4 to 3.3.6 Bumps [doxysphinx](https://github.com/boschglobal/doxysphinx) from 3.3.4 to 3.3.6. - [Release notes](https://github.com/boschglobal/doxysphinx/releases) - [Changelog](https://github.com/boschglobal/doxysphinx/blob/main/CHANGELOG.md) - [Commits](https://github.com/boschglobal/doxysphinx/compare/v3.3.4...v3.3.6) --- updated-dependencies: - dependency-name: doxysphinx dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 9a59f1b9..a7be7182 100644 --- a/requirements.txt +++ b/requirements.txt @@ -63,7 +63,7 @@ docutils==0.19 # myst-parser # pydata-sphinx-theme # sphinx -doxysphinx==3.3.4 +doxysphinx==3.3.6 # via rocm-docs-core (pyproject.toml) exceptiongroup==1.1.3 # via pytest From ff1260a8afc97e907b9c8378a86ab1db3af38241 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Mon, 16 Oct 2023 11:08:17 +0000 Subject: [PATCH 011/238] feat(projects.py): Allow to fetch project indices explicitly --- docs/conf.py | 1 + docs/developer_guide/projects_yaml.md | 15 ++++ src/rocm_docs/projects.py | 34 +++++++- tests/test_sites.py | 109 +++++++++++++++++++++++++- 4 files changed, 157 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 86eab256..b426f9a2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,6 +11,7 @@ # Disable fetching projects.yaml, it would be the same as the local one anyway # except if a PR modifies it. We want to test with its version in that case external_projects_remote_repository = "" +external_projects = ["hipify", "python", "rocm-docs-core"] external_projects_current_project = "rocm-docs-core" diff --git a/docs/developer_guide/projects_yaml.md b/docs/developer_guide/projects_yaml.md index 287af880..fc46f38b 100644 --- a/docs/developer_guide/projects_yaml.md +++ b/docs/developer_guide/projects_yaml.md @@ -40,3 +40,18 @@ Vice-versa if A has set its `development_branch` to `develop` and B sets it to ` Symbolic versions "latest" and "stable" map to themselves in other projects. Any other branch maps to "latest". + +## Explicitly list external projects + +By default the inventories of all external projects defined in `projets.yaml` +will be downloaded. This can take a long time as it requires a network request +for each external project. + +The `external_projects` configuration option can be set to a list with the names +of remote projects to fetch inventories from & enable links to. +The list must be a subset of the project names defined in `projects.yaml`. +The default value of `"all"` means to fetch all projects. + +References to projects that are not in `external_projects` will not be resolved. +This applies to the terms of contents too, where unresolved references will +likely cause an error. diff --git a/src/rocm_docs/projects.py b/src/rocm_docs/projects.py index 54e03821..ba27e797 100644 --- a/src/rocm_docs/projects.py +++ b/src/rocm_docs/projects.py @@ -314,6 +314,33 @@ def _update_theme_configs( app.config.projects_version_type = util.VersionType.DEVELOPMENT # type: ignore[attr-defined] +def _get_external_projects( + app: Sphinx, default: Dict[str, ProjectMapping] +) -> List[str]: + external_projects: Union[List[str], str] = app.config.external_projects + if external_projects == "all": + return list(default.keys()) + if isinstance(external_projects, str): + logger.error( + f'Unexpected value "{external_projects}" in external_projects.\n' + 'Must be set to a list of project names or "all" to ' + "enable all projects defined in projects.yaml" + ) + return [] + + unknown_projects = [p for p in external_projects if p not in default] + if len(unknown_projects) > 0: + known_projects = [f'"{p}"' for p in default] + unknown_projects = [f'"{p}"' for p in unknown_projects] + logger.error( + "Unknown projects: [{}] in external_projects.\n".format( + ", ".join(unknown_projects) + ) + + "Valid projects are: [{}]".format(", ".join(known_projects)) + ) + return external_projects + + def _update_config(app: Sphinx, _: Config) -> None: if not config_provided_by_user(app, "intersphinx_disabled_domains"): app.config.intersphinx_disabled_domains = ["std"] # type: ignore[attr-defined] @@ -328,10 +355,12 @@ def _update_config(app: Sphinx, _: Config) -> None: projects, app.config.external_projects_current_project ) default = _create_mapping(projects, current_project, branch) + external_projects = _get_external_projects(app, default) mapping: Dict[str, ProjectMapping] = app.config.intersphinx_mapping for key, value in default.items(): - mapping.setdefault(key, value) + if key in external_projects: + mapping.setdefault(key, value) if not config_provided_by_user(app, "external_toc_path"): app.config.external_toc_path = "./.sphinx/_toc.yml" # type: ignore[attr-defined] @@ -377,6 +406,9 @@ def setup(app: Sphinx) -> Dict[str, Any]: rebuild="env", types=str, ) + app.add_config_value( + "external_projects", "all", rebuild="env", types=[list, str] + ) def external_toc_template_default(config: Config) -> str: toc_path = Path(config.external_toc_path) diff --git a/tests/test_sites.py b/tests/test_sites.py index fd193d85..0669ff16 100644 --- a/tests/test_sites.py +++ b/tests/test_sites.py @@ -1,7 +1,8 @@ from __future__ import annotations -from typing import Callable +from typing import Any, Callable, Literal +import unittest.mock from pathlib import Path import pytest @@ -9,6 +10,7 @@ import rocm_docs.projects +from .log_fixtures import ExpectLogFixture from .sphinx_fixtures import SITES_BASEFOLDER, TEMPLATE_FOLDER @@ -53,3 +55,108 @@ def test_pass( ) -> None: app = build_factory() app.build() + + +def str_or_list_to_id(val: str | list[str]) -> str: + if isinstance(val, str): + return val + return ",".join(val) + + +def create_external_project_app( + srcdir: Path, external_projects: Any +) -> unittest.mock.NonCallableMock: + app = unittest.mock.NonCallableMock() + app.srcdir = srcdir + app.config = unittest.mock.NonCallableMock() + app.config.overrides = [] + app.config._raw_config = { + "external_projects_current_project": "a", + "external_projects": external_projects, + "external_toc_template_path": TEMPLATE_FOLDER + / ".sphinx" + / "_toc.yml.in", + "external_toc_path": "_toc.yml", + "intersphinx_mapping": {}, + } + app.config.configure_mock(**app.config._raw_config) + return app + + +@pytest.mark.parametrize( + "external_projects", + [[], ["a"], ["b"], ["a", "b"], "all"], + ids=str_or_list_to_id, +) +@pytest.mark.usefixtures("_no_unexpected_warnings") +def test_external_projects( + external_projects: list[str] | Literal["all"], + mocked_projects: dict[str, rocm_docs.projects._Project], + tmp_path: Path, + with_no_git_repo: ExpectLogFixture.Validator, +) -> None: + with_no_git_repo.required = False + app = create_external_project_app(tmp_path, external_projects) + rocm_docs.projects._update_config(app, app.config) + + keys = ( + external_projects + if external_projects != "all" + else mocked_projects.keys() + ) + + expected_mapping = { + k: (v.target, tuple(v.inventory)) + for k, v in mocked_projects.items() + if k in keys + } + assert app.config.intersphinx_mapping == expected_mapping + + expected_context = { + k: v.target for k, v in mocked_projects.items() if k in keys + } + assert app.config.projects_context["projects"] == expected_context + + +@pytest.mark.usefixtures("mocked_projects", "_no_unexpected_warnings") +def test_external_projects_invalid_value( + expect_log: ExpectLogFixture, + with_no_git_repo: ExpectLogFixture.Validator, + tmp_path: Path, +) -> None: + with_no_git_repo.required = False + app = create_external_project_app(tmp_path, "invalid_value") + + with expect_log( + "sphinx.rocm_docs.projects", + "ERROR", + 'Unexpected value "invalid_value" in external_projects.\n' + 'Must be set to a list of project names or "all" to enable all projects' + " defined in projects.yaml", + ): + rocm_docs.projects._update_config(app, app.config) + + +@pytest.mark.usefixtures("_no_unexpected_warnings") +def test_external_projects_unkown_project( + expect_log: ExpectLogFixture, + mocked_projects: dict[str, rocm_docs.projects._Project], + with_no_git_repo: ExpectLogFixture.Validator, + tmp_path: Path, +) -> None: + with_no_git_repo.required = False + # First keys of mocked_projects + a_defined_project = next(iter(mocked_projects.keys())) + app = create_external_project_app( + tmp_path, [a_defined_project, "unknown_project", "foo"] + ) + + with expect_log( + "sphinx.rocm_docs.projects", + "ERROR", + 'Unknown projects: ["unknown_project", "foo"] in external_projects.\n' + "Valid projects are: [{}]".format( + ", ".join([f'"{p}"' for p in mocked_projects]) + ), + ): + rocm_docs.projects._update_config(app, app.config) From 724f084a6dc991ed2e10f45ff442b547249b3ae9 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Mon, 16 Oct 2023 11:12:43 +0000 Subject: [PATCH 012/238] style: Enable more ruff checks and fix errors reported --- pyproject.toml | 5 +-- src/rocm_docs/__init__.py | 16 +++++----- src/rocm_docs/core.py | 12 ++++--- src/rocm_docs/doxygen.py | 6 ++-- src/rocm_docs/formatting.py | 8 +++-- src/rocm_docs/projects.py | 62 +++++++++++++++++++------------------ src/rocm_docs/theme.py | 12 ++++--- src/rocm_docs/util.py | 5 ++- 8 files changed, 69 insertions(+), 57 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 0a3328d6..ef9c5698 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -81,7 +81,7 @@ major_version_zero = true [tool.isort] # https://github.com/timothycrosley/isort/ py_version = 38 -line_length = 100 +line_length = 80 known_typing = ["typing", "types", "typing_extensions", "mypy", "mypy_extensions"] sections = ["FUTURE", "TYPING", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"] @@ -115,13 +115,14 @@ warn_unused_configs = true warn_unused_ignores = true [tool.ruff] -select = ["ARG", "F", "E", "W", "N", "D", "UP", "RET"] +select = ["ARG","C4","D","E","F","FA","N","PT","RET","RUF","SIM","UP","W"] ignore = ["E501", "D203", "D213", "D4"] exclude = ["tests/sites", "tests/templates"] target-version = "py38" line-length = 80 [tool.ruff.per-file-ignores] +"src/**/*" = ["PT"] "tests/conftest.py" = ["F401", "F403"] "tests/test_*.py" = ["D"] diff --git a/src/rocm_docs/__init__.py b/src/rocm_docs/__init__.py index 89b72400..b66d6292 100644 --- a/src/rocm_docs/__init__.py +++ b/src/rocm_docs/__init__.py @@ -4,7 +4,9 @@ that are using Read the Docs. """ -from typing import Dict, List, Optional, Union +from __future__ import annotations + +from typing import ClassVar, Union import os @@ -19,7 +21,7 @@ class ROCmDocs: """A class to contain all of the Sphinx variables.""" - SPHINX_VARS = [ + SPHINX_VARS: ClassVar = [ "extensions", "html_title", "html_theme", @@ -33,17 +35,17 @@ class ROCmDocs: def __init__( self, project_name: str, - _: Optional[str] = None, + _: str | None = None, __: MaybePath = None, ) -> None: """Intialize ROCmDocs.""" self._project_name: str = project_name - self.extensions: List[str] = [] + self.extensions: list[str] = [] self.html_title: str self.html_theme: str - self.html_theme_options: Dict[str, Union[str, bool, List[str]]] = {} + self.html_theme_options: dict[str, str | bool | list[str]] = {} self.doxygen_root: MaybePath = None - self.doxygen_project: Dict[str, Union[Optional[str], MaybePath]] = { + self.doxygen_project: dict[str, MaybePath] = { "name": None, "path": None, } @@ -59,7 +61,7 @@ def run_doxygen( self, doxygen_root: MaybePath = None, doxygen_path: MaybePath = None, - doxygen_file: Optional[str] = None, + doxygen_file: str | None = None, ) -> None: """Run doxygen as part of Sphinx by adding rocm_docs.doxygen.""" if "rocm_docs.doxygen" not in self.extensions: diff --git a/src/rocm_docs/core.py b/src/rocm_docs/core.py index a46be265..485a37c0 100644 --- a/src/rocm_docs/core.py +++ b/src/rocm_docs/core.py @@ -18,7 +18,9 @@ import bs4 import git.repo -from pydata_sphinx_theme.utils import config_provided_by_user # type: ignore[import] +from pydata_sphinx_theme.utils import ( # type: ignore[import] + config_provided_by_user, +) from sphinx.application import Sphinx from sphinx.config import Config @@ -152,7 +154,7 @@ def _set_page_article_info( continue article_os_info = "" - if "os" not in page.keys(): + if "os" not in page: page["os"] = app.config.all_article_info_os if "linux" in page["os"]: article_os_info += "Linux" @@ -163,12 +165,12 @@ def _set_page_article_info( modified_info = article_info.replace("", article_os_info) author = app.config.all_article_info_author - if "author" in page.keys(): + if "author" in page: author = page["author"] modified_info = modified_info.replace("AMD", author) date_info: str | None = None - if "date" in page.keys(): + if "date" in page: date_info = page["date"] else: date_info = _get_time_last_modified(repo, path_source) @@ -178,7 +180,7 @@ def _set_page_article_info( modified_info = modified_info.replace("2023", date_info) - if "read-time" in page.keys(): + if "read-time" in page: read_time = page["read-time"] else: read_time = _estimate_read_time(path_html) diff --git a/src/rocm_docs/doxygen.py b/src/rocm_docs/doxygen.py index 907bfb50..697e790b 100644 --- a/src/rocm_docs/doxygen.py +++ b/src/rocm_docs/doxygen.py @@ -11,7 +11,9 @@ import sys from pathlib import Path -from pydata_sphinx_theme.utils import config_provided_by_user # type: ignore[import] +from pydata_sphinx_theme.utils import ( # type: ignore[import] + config_provided_by_user, +) from sphinx.application import Sphinx from sphinx.config import Config from sphinx.errors import ConfigError @@ -124,7 +126,7 @@ def _update_breathe_settings(app: Sphinx, doxygen_root: Path) -> None: except FileNotFoundError as err: raise NotADirectoryError( "Expected doxygen to generate the folder" - f" {str(doxygen_root)} but it could not be found." + f" {doxygen_root!s} but it could not be found." ) from err setattr(app.config, "breathe_projects", {project_name: str(xml_path)}) diff --git a/src/rocm_docs/formatting.py b/src/rocm_docs/formatting.py index 3895ac6e..83e6900c 100644 --- a/src/rocm_docs/formatting.py +++ b/src/rocm_docs/formatting.py @@ -47,9 +47,11 @@ def _format_directive(self, match: re.Match[str]) -> _Replacement | None: # As a special case allow `{branch}` and `url` to alias `${branch}` # and '${url}' respectively for backwards compatibility. # Otherwise the '$' is required - if match["prefix"] is None: - if match["directive"] not in ["branch", "url"]: - return None + if match["prefix"] is None and match["directive"] not in [ + "branch", + "url", + ]: + return None if match["directive"] in ["branch", "url"]: return self._format_simple( diff --git a/src/rocm_docs/projects.py b/src/rocm_docs/projects.py index ba27e797..0545ddcc 100644 --- a/src/rocm_docs/projects.py +++ b/src/rocm_docs/projects.py @@ -3,7 +3,9 @@ Remote loading of intersphinx_mapping from file, templating projects in toc.yml). """ -from typing import Any, Dict, List, Optional, Tuple, Union, cast +from __future__ import annotations + +from typing import Any, Dict, List, Tuple, Union, cast import functools import json @@ -16,7 +18,9 @@ import github import sphinx.util.logging import yaml -from pydata_sphinx_theme.utils import config_provided_by_user # type: ignore[import] +from pydata_sphinx_theme.utils import ( # type: ignore[import] + config_provided_by_user, +) from sphinx.application import Sphinx from sphinx.config import Config @@ -58,12 +62,12 @@ class InvalidMappingFileError(RuntimeError): @dataclass class _Project: target: str - inventory: List[Union[str, None]] + inventory: list[str | None] development_branch: str @staticmethod @functools.lru_cache - def yaml_schema() -> Dict[str, Any]: + def yaml_schema() -> dict[str, Any]: base = importlib_resources.files("rocm_docs") / "data" schema_file = base / "projects.schema.json" @@ -72,7 +76,7 @@ def yaml_schema() -> Dict[str, Any]: ) @classmethod - def schema(cls) -> Dict[str, Any]: + def schema(cls) -> dict[str, Any]: return cast(Dict[str, Any], cls.yaml_schema()["$defs"]["project"]) @classmethod @@ -80,7 +84,7 @@ def default_value(cls, prop: str) -> str: return cast(str, cls.schema()["properties"][prop]["default"]) @classmethod - def from_yaml_entry(cls, entry: ProjectEntry) -> "_Project": + def from_yaml_entry(cls, entry: ProjectEntry) -> _Project: """Create from an entry that conforms to the project schema.""" if isinstance(entry, str): return _Project( @@ -105,8 +109,8 @@ def from_yaml_entry(cls, entry: ProjectEntry) -> "_Project": def get_static_version( cls, current_branch: str, - current_project: Optional["_Project"], - ) -> Optional[str]: + current_project: _Project | None, + ) -> str | None: """Returns a common static version if it exists. In some cases all remote projects will receive the same version, @@ -130,7 +134,7 @@ def get_static_version( return None - def evaluate(self, static_version: Optional[str]) -> None: + def evaluate(self, static_version: str | None) -> None: """Evaluate ${version} placeholders in the inventory and target values.""" version = ( static_version @@ -149,16 +153,14 @@ def mapping(self) -> ProjectMapping: return (self.target, tuple(self.inventory)) -def _create_projects( - project_yaml: Union[str, Traversable] -) -> Dict[str, _Project]: +def _create_projects(project_yaml: str | Traversable) -> dict[str, _Project]: contents = yaml.safe_load( project_yaml if isinstance(project_yaml, str) else project_yaml.open(encoding="utf-8") ) - data: Dict[str, Union[int, Dict[str, ProjectEntry]]] + data: dict[str, int | dict[str, ProjectEntry]] try: data = fastjsonschema.validate(_Project.yaml_schema(), contents) except fastjsonschema.exceptions.JsonSchemaValueException as err: @@ -174,8 +176,8 @@ def _create_projects( def _get_current_project( - projects: Dict[str, _Project], current_id: str -) -> Optional[_Project]: + projects: dict[str, _Project], current_id: str +) -> _Project | None: if current_id in projects: return projects[current_id] @@ -188,10 +190,10 @@ def _get_current_project( def _create_mapping( - projects: Dict[str, _Project], - current_project: Optional[_Project], + projects: dict[str, _Project], + current_project: _Project | None, current_branch: str, -) -> Dict[str, ProjectMapping]: +) -> dict[str, ProjectMapping]: static_version = _Project.get_static_version( current_branch, current_project ) @@ -230,11 +232,11 @@ def _fetch_projects( def _load_projects( remote_repository: str, remote_branch: str -) -> Dict[str, _Project]: +) -> dict[str, _Project]: projects_file_loc = "data/projects.yaml" def should_fetch_mappings( - remote_repository: Optional[str], remote_branch: Optional[str] + remote_repository: str | None, remote_branch: str | None ) -> bool: if not remote_repository: logger.info( @@ -255,7 +257,7 @@ def should_fetch_mappings( ) return True - projects: Optional[Dict[str, _Project]] = None + projects: dict[str, _Project] | None = None if should_fetch_mappings(remote_repository, remote_branch): try: remote_filepath = "src/rocm_docs/" + projects_file_loc @@ -281,8 +283,8 @@ def should_fetch_mappings( def _get_context( - repo_path: Path, mapping: Dict[str, ProjectMapping] -) -> Dict[str, Any]: + repo_path: Path, mapping: dict[str, ProjectMapping] +) -> dict[str, Any]: url, branch = util.get_branch(repo_path) return { "url": url, @@ -292,7 +294,7 @@ def _get_context( def _update_theme_configs( - app: Sphinx, current_project: Optional[_Project], current_branch: str + app: Sphinx, current_project: _Project | None, current_branch: str ) -> None: """Update configurations for use in theme.py""" latest_version = "5.7.1" @@ -315,9 +317,9 @@ def _update_theme_configs( def _get_external_projects( - app: Sphinx, default: Dict[str, ProjectMapping] -) -> List[str]: - external_projects: Union[List[str], str] = app.config.external_projects + app: Sphinx, default: dict[str, ProjectMapping] +) -> list[str]: + external_projects: list[str] | str = app.config.external_projects if external_projects == "all": return list(default.keys()) if isinstance(external_projects, str): @@ -357,7 +359,7 @@ def _update_config(app: Sphinx, _: Config) -> None: default = _create_mapping(projects, current_project, branch) external_projects = _get_external_projects(app, default) - mapping: Dict[str, ProjectMapping] = app.config.intersphinx_mapping + mapping: dict[str, ProjectMapping] = app.config.intersphinx_mapping for key, value in default.items(): if key in external_projects: mapping.setdefault(key, value) @@ -378,12 +380,12 @@ def _update_config(app: Sphinx, _: Config) -> None: def _setup_projects_context( - app: Sphinx, _: str, __: str, context: Dict[str, Any], ___: Any + app: Sphinx, _: str, __: str, context: dict[str, Any], ___: Any ) -> None: context["projects"] = app.config.projects_context["projects"] -def setup(app: Sphinx) -> Dict[str, Any]: +def setup(app: Sphinx) -> dict[str, Any]: """Setup rocm_docs.projects as a sphinx extension.""" app.setup_extension("sphinx.ext.intersphinx") app.setup_extension("sphinx_external_toc") diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py index debf6e48..b1fb7869 100644 --- a/src/rocm_docs/theme.py +++ b/src/rocm_docs/theme.py @@ -1,6 +1,8 @@ """Module to use rocm-docs-core as a theme.""" -from typing import Any, Dict +from __future__ import annotations + +from typing import Any from pathlib import Path @@ -16,8 +18,8 @@ logger = sphinx.util.logging.getLogger(__name__) -def _update_repo_opts(srcdir: str, theme_opts: Dict[str, Any]) -> None: - default_branch_options: Dict[str, Any] = { +def _update_repo_opts(srcdir: str, theme_opts: dict[str, Any]) -> None: + default_branch_options: dict[str, Any] = { "use_edit_page_button": False, } try: @@ -37,7 +39,7 @@ def _update_repo_opts(srcdir: str, theme_opts: Dict[str, Any]) -> None: def _update_banner( - flavor: str, version_type: util.VersionType, theme_opts: Dict[str, Any] + flavor: str, version_type: util.VersionType, theme_opts: dict[str, Any] ) -> None: if flavor != "rocm": return @@ -98,7 +100,7 @@ def _update_theme_options(app: Sphinx) -> None: setattr(app.config, key, default) -def setup(app: Sphinx) -> Dict[str, Any]: +def setup(app: Sphinx) -> dict[str, Any]: """Set up the module as a Sphinx extension.""" app.add_js_file( "https://download.amd.com/js/analytics/analyticsinit.js", diff --git a/src/rocm_docs/util.py b/src/rocm_docs/util.py index 5f2fb6f1..817438b2 100644 --- a/src/rocm_docs/util.py +++ b/src/rocm_docs/util.py @@ -163,9 +163,8 @@ def copy_from_package( # unzipping and/or the creation of a temporary file. # This is not the case when opening the file as a # stream. - with entry.open("rb") as infile: - with open(entry_path, "wb") as out: - shutil.copyfileobj(infile, out) + with entry.open("rb") as infile, open(entry_path, "wb") as out: + shutil.copyfileobj(infile, out) __all__ = [ From f97cd58c47b4cc5fcfcadd741f050c7a086e6b3c Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Mon, 16 Oct 2023 12:55:38 +0000 Subject: [PATCH 013/238] style: Switch to the dedicated black formatter extension for vscode The built-in support of formatters in the python extension is deprecated, and the functionality has been broken out to individual extensions. Let's use the new extensions for devcontainers, both vscode and gitpod. More details can be found at: https://github.com/microsoft/vscode-python/wiki/Migration-to-Python-Tools-Extensions --- .devcontainer/devcontainer.json | 1 + .gitpod.yml | 1 + .vscode/settings.json | 6 ++++-- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 056a889f..269d7d51 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -7,6 +7,7 @@ "vscode": { "extensions": [ "bungcip.better-toml", + "ms-python.black-formatter", "ms-python.python", "ritwickdey.LiveServer" ] diff --git a/.gitpod.yml b/.gitpod.yml index b4cd157d..c6a5b707 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -9,4 +9,5 @@ vscode: extensions: - bungcip.better-toml - ms-python.python + - ms-python.black-formatter - ritwickdey.LiveServer diff --git a/.vscode/settings.json b/.vscode/settings.json index 8e3d175e..087d5b4d 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,8 +2,10 @@ "liveServer.settings.root": "docs/_build/html", "liveServer.settings.wait": 1000, "python.terminal.activateEnvInCurrentTerminal": true, - "python.formatting.provider": "black", - "python.formatting.blackArgs": [ + "[python]": { + "editor.defaultFormatter": "ms-python.black-formatter" + }, + "black-formatter.args": [ "--config", "pyproject.toml" ], From 72047d26f2f4a9b77bad29dc7a7940f76b14c94a Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Wed, 18 Oct 2023 13:21:03 +0000 Subject: [PATCH 014/238] style: Fix a couple of typos --- docs/developer_guide/projects_yaml.md | 2 +- tests/log_fixtures.py | 4 ++-- tests/test_sites.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/developer_guide/projects_yaml.md b/docs/developer_guide/projects_yaml.md index fc46f38b..f76e7fbe 100644 --- a/docs/developer_guide/projects_yaml.md +++ b/docs/developer_guide/projects_yaml.md @@ -43,7 +43,7 @@ Any other branch maps to "latest". ## Explicitly list external projects -By default the inventories of all external projects defined in `projets.yaml` +By default the inventories of all external projects defined in `projects.yaml` will be downloaded. This can take a long time as it requires a network request for each external project. diff --git a/tests/log_fixtures.py b/tests/log_fixtures.py index ffd213bd..3ea167e3 100644 --- a/tests/log_fixtures.py +++ b/tests/log_fixtures.py @@ -241,7 +241,7 @@ def __call__( """Register a new handler. See expect_log for more details""" levelno = logging.getLevelName(level) if not isinstance(levelno, int): - raise ValueError(f'Unkown log level "{level}"') + raise ValueError(f'Unknown log level "{level}"') return self.Validator( self._log_handler_stack.new_scope(when=when), @@ -259,7 +259,7 @@ def expect_log( """Register a verifier for a log message Each call to expect_log(name, level, msg) will verify that such a log is - emitted at least once. This log will not trigger unkown warning checks. + emitted at least once. This log will not trigger unknown warning checks. Set capture_all to True to capture all warnings that match, not just the first. """ return ExpectLogFixture(log_handler_stack, expected_logs) diff --git a/tests/test_sites.py b/tests/test_sites.py index 0669ff16..5320fafd 100644 --- a/tests/test_sites.py +++ b/tests/test_sites.py @@ -138,7 +138,7 @@ def test_external_projects_invalid_value( @pytest.mark.usefixtures("_no_unexpected_warnings") -def test_external_projects_unkown_project( +def test_external_projects_unknown_project( expect_log: ExpectLogFixture, mocked_projects: dict[str, rocm_docs.projects._Project], with_no_git_repo: ExpectLogFixture.Validator, From 0b3237589d70e9848989babd6b8373813a3e824a Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Wed, 18 Oct 2023 13:58:50 +0000 Subject: [PATCH 015/238] build(deps): Upgrade dependencies Mypy had some new errors related to untyped imports, those are fixed in this commit. --- requirements.txt | 18 +++++++++--------- src/rocm_docs/core.py | 2 +- src/rocm_docs/doxygen.py | 2 +- src/rocm_docs/projects.py | 4 ++-- src/rocm_docs/theme.py | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/requirements.txt b/requirements.txt index 6b0636a9..d4f07184 100644 --- a/requirements.txt +++ b/requirements.txt @@ -16,7 +16,7 @@ babel==2.13.0 # sphinx beautifulsoup4==4.12.2 # via pydata-sphinx-theme -black==23.9.1 +black==23.10.0 # via rocm-docs-core (pyproject.toml) breathe==4.35.0 # via rocm-docs-core (pyproject.toml) @@ -47,7 +47,7 @@ click-log==0.4.0 # via doxysphinx colorama==0.4.6 # via commitizen -commitizen==3.9.0 +commitizen==3.12.0 # via rocm-docs-core (pyproject.toml) cryptography==41.0.4 # via pyjwt @@ -73,7 +73,7 @@ filelock==3.12.4 # via virtualenv gitdb==4.0.10 # via gitpython -gitpython==3.1.37 +gitpython==3.1.38 # via rocm-docs-core (pyproject.toml) identify==2.5.30 # via pre-commit @@ -86,7 +86,7 @@ importlib-metadata==6.8.0 # build # commitizen # sphinx -importlib-resources==5.12.0 ; python_version < "3.9" +importlib-resources==6.1.0 ; python_version < "3.9" # via rocm-docs-core (pyproject.toml) iniconfig==2.0.0 # via pytest @@ -113,7 +113,7 @@ mdurl==0.1.2 # via markdown-it-py mpire==2.8.0 # via doxysphinx -mypy==1.5.1 +mypy==1.6.1 # via rocm-docs-core (pyproject.toml) mypy-extensions==1.0.0 # via @@ -143,7 +143,7 @@ pluggy==1.3.0 # via pytest pre-commit==3.5.0 # via rocm-docs-core (pyproject.toml) -prompt-toolkit==3.0.39 +prompt-toolkit==3.0.36 # via questionary pycparser==2.21 # via cffi @@ -182,13 +182,13 @@ pyyaml==6.0.1 # pre-commit # rocm-docs-core (pyproject.toml) # sphinx-external-toc -questionary==1.10.0 +questionary==2.0.1 # via commitizen requests==2.31.0 # via # pygithub # sphinx -ruff==0.0.292 +ruff==0.1.0 # via rocm-docs-core (pyproject.toml) six==1.16.0 # via python-dateutil @@ -251,7 +251,7 @@ typing-extensions==4.8.0 # mypy # pydata-sphinx-theme # pygithub -urllib3==2.0.6 +urllib3==2.0.7 # via # pygithub # requests diff --git a/src/rocm_docs/core.py b/src/rocm_docs/core.py index 485a37c0..a59f2b96 100644 --- a/src/rocm_docs/core.py +++ b/src/rocm_docs/core.py @@ -18,7 +18,7 @@ import bs4 import git.repo -from pydata_sphinx_theme.utils import ( # type: ignore[import] +from pydata_sphinx_theme.utils import ( # type: ignore[import-untyped] config_provided_by_user, ) from sphinx.application import Sphinx diff --git a/src/rocm_docs/doxygen.py b/src/rocm_docs/doxygen.py index 697e790b..7d0544d3 100644 --- a/src/rocm_docs/doxygen.py +++ b/src/rocm_docs/doxygen.py @@ -11,7 +11,7 @@ import sys from pathlib import Path -from pydata_sphinx_theme.utils import ( # type: ignore[import] +from pydata_sphinx_theme.utils import ( # type: ignore[import-untyped] config_provided_by_user, ) from sphinx.application import Sphinx diff --git a/src/rocm_docs/projects.py b/src/rocm_docs/projects.py index 0545ddcc..64edff44 100644 --- a/src/rocm_docs/projects.py +++ b/src/rocm_docs/projects.py @@ -14,11 +14,11 @@ from dataclasses import dataclass from pathlib import Path -import fastjsonschema # type: ignore[import] +import fastjsonschema # type: ignore[import-untyped] import github import sphinx.util.logging import yaml -from pydata_sphinx_theme.utils import ( # type: ignore[import] +from pydata_sphinx_theme.utils import ( # type: ignore[import-untyped] config_provided_by_user, ) from sphinx.application import Sphinx diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py index b1fb7869..10d751ea 100644 --- a/src/rocm_docs/theme.py +++ b/src/rocm_docs/theme.py @@ -7,7 +7,7 @@ from pathlib import Path import sphinx.util.logging -from pydata_sphinx_theme.utils import ( # type: ignore[import] +from pydata_sphinx_theme.utils import ( # type: ignore[import-untyped] config_provided_by_user, get_theme_options_dict, ) From 14d6c545819e7a5e03b50f126870c9524d165eee Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Fri, 20 Oct 2023 09:37:25 +0000 Subject: [PATCH 016/238] test: Print log level name instead of numeric value in unexpected logs --- tests/log_fixtures.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/log_fixtures.py b/tests/log_fixtures.py index 3ea167e3..b58778e6 100644 --- a/tests/log_fixtures.py +++ b/tests/log_fixtures.py @@ -116,7 +116,7 @@ def validate(self, records: Iterable[logging.LogRecord]) -> None: if r not in expected_logs_impl: self.logrecord = ( r.name, - logging.getLevelName(r.levelname), + r.levelname, r.getMessage(), ) return From b8e5a8d0617d229db61c5595e22f48a7c32a1286 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Fri, 20 Oct 2023 09:52:47 +0000 Subject: [PATCH 017/238] docs(commitizen.md): Document the chore type --- docs/developer_guide/commitizen.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/developer_guide/commitizen.md b/docs/developer_guide/commitizen.md index f7509a8a..7f4548ba 100644 --- a/docs/developer_guide/commitizen.md +++ b/docs/developer_guide/commitizen.md @@ -33,6 +33,8 @@ Type must be one of: - **`style`**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) - **`test`**: Adding missing tests or correcting existing tests +- **`chore`**: Other changes that don't modify source code, test or build files + (e.g changing `.gitignore`) The **scope** if included should be the area the change affects in parentheses i.e. `(theme)` for theming changes or `(deps)` for changes to the list of From 79f62b93a3ad63b4a2bc00ab1fcd774c5f793626 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Fri, 20 Oct 2023 09:53:29 +0000 Subject: [PATCH 018/238] chore(.gitignore): remove unused ignores --- docs/.gitignore | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/.gitignore b/docs/.gitignore index be0c0e78..68d91289 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,4 +1,2 @@ /_build /_doxygen -404.md -data/AMD-404.png From 5d88e6d1e24bfe3ebcc9d3f8acac42647bc76c6e Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Fri, 20 Oct 2023 12:41:46 +0000 Subject: [PATCH 019/238] chore(justfile): allow passing extra args to pip-compile --- justfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/justfile b/justfile index 6a59cbbc..619c4358 100644 --- a/justfile +++ b/justfile @@ -26,8 +26,8 @@ deps: _install-pip-tools {{python}} -m mypy --non-interactive --install-types src # (Re-)lock the dependencies with pip-compile -lock-deps: - {{python}} -m piptools compile --all-extras pyproject.toml +lock-deps +extra_args="": + {{python}} -m piptools compile --all-extras {{extra_args}} pyproject.toml # Install git-hooks for development install-git-hooks: From 0a491afe2a17fc1c12170ed344f2ba7b1dc89f77 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 20 Oct 2023 12:53:09 +0000 Subject: [PATCH 020/238] build(deps): bump ruff from 0.1.0 to 0.1.1 Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.0 to 0.1.1. - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](https://github.com/astral-sh/ruff/compare/v0.1.0...v0.1.1) --- updated-dependencies: - dependency-name: ruff dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d4f07184..16e6efa9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -188,7 +188,7 @@ requests==2.31.0 # via # pygithub # sphinx -ruff==0.1.0 +ruff==0.1.1 # via rocm-docs-core (pyproject.toml) six==1.16.0 # via python-dateutil From fac1e27b1aa48c30e981cbc62fedb88f6a090b03 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 20 Oct 2023 12:53:29 +0000 Subject: [PATCH 021/238] build(deps): bump doxysphinx from 3.3.6 to 3.3.7 Bumps [doxysphinx](https://github.com/boschglobal/doxysphinx) from 3.3.6 to 3.3.7. - [Release notes](https://github.com/boschglobal/doxysphinx/releases) - [Changelog](https://github.com/boschglobal/doxysphinx/blob/main/CHANGELOG.md) - [Commits](https://github.com/boschglobal/doxysphinx/compare/v3.3.6...v3.3.7) --- updated-dependencies: - dependency-name: doxysphinx dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d4f07184..bd1579ba 100644 --- a/requirements.txt +++ b/requirements.txt @@ -63,7 +63,7 @@ docutils==0.19 # myst-parser # pydata-sphinx-theme # sphinx -doxysphinx==3.3.6 +doxysphinx==3.3.7 # via rocm-docs-core (pyproject.toml) exceptiongroup==1.1.3 # via pytest From cd2f058907005bc5d3d7eb04cba7006ec1b7fd39 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 20 Oct 2023 12:53:35 +0000 Subject: [PATCH 022/238] build(deps): bump gitdb from 4.0.10 to 4.0.11 Bumps [gitdb](https://github.com/gitpython-developers/gitdb) from 4.0.10 to 4.0.11. - [Release notes](https://github.com/gitpython-developers/gitdb/releases) - [Commits](https://github.com/gitpython-developers/gitdb/compare/4.0.10...4.0.11) --- updated-dependencies: - dependency-name: gitdb dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d4f07184..06279a23 100644 --- a/requirements.txt +++ b/requirements.txt @@ -71,7 +71,7 @@ fastjsonschema==2.18.1 # via rocm-docs-core (pyproject.toml) filelock==3.12.4 # via virtualenv -gitdb==4.0.10 +gitdb==4.0.11 # via gitpython gitpython==3.1.38 # via rocm-docs-core (pyproject.toml) From 9ccc6e4f269b3386289e917b010a662ac5053937 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 20 Oct 2023 12:53:48 +0000 Subject: [PATCH 023/238] build(deps): bump gitpython from 3.1.38 to 3.1.40 Bumps [gitpython](https://github.com/gitpython-developers/GitPython) from 3.1.38 to 3.1.40. - [Release notes](https://github.com/gitpython-developers/GitPython/releases) - [Changelog](https://github.com/gitpython-developers/GitPython/blob/main/CHANGES) - [Commits](https://github.com/gitpython-developers/GitPython/compare/3.1.38...3.1.40) --- updated-dependencies: - dependency-name: gitpython dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d4f07184..aadd5d1d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -73,7 +73,7 @@ filelock==3.12.4 # via virtualenv gitdb==4.0.10 # via gitpython -gitpython==3.1.38 +gitpython==3.1.40 # via rocm-docs-core (pyproject.toml) identify==2.5.30 # via pre-commit From 581ff35b341be2cabc5187e1491cb13fc5f1f958 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:54:18 +0000 Subject: [PATCH 024/238] build(deps): bump charset-normalizer from 3.3.0 to 3.3.1 Bumps [charset-normalizer](https://github.com/Ousret/charset_normalizer) from 3.3.0 to 3.3.1. - [Release notes](https://github.com/Ousret/charset_normalizer/releases) - [Changelog](https://github.com/Ousret/charset_normalizer/blob/master/CHANGELOG.md) - [Commits](https://github.com/Ousret/charset_normalizer/compare/3.3.0...3.3.1) --- updated-dependencies: - dependency-name: charset-normalizer dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index fd155904..aef85107 100644 --- a/requirements.txt +++ b/requirements.txt @@ -32,7 +32,7 @@ cffi==1.16.0 # pynacl cfgv==3.4.0 # via pre-commit -charset-normalizer==3.3.0 +charset-normalizer==3.3.1 # via # commitizen # requests From 90cf85359d9ea1423c3137e793fd5ee8805c6830 Mon Sep 17 00:00:00 2001 From: Gergely Meszaros Date: Tue, 17 Oct 2023 15:11:03 +0000 Subject: [PATCH 025/238] test: Add tests for doxygen support Add End-to-End tests for doxygen using both the legacy and the extension interfaces. The tests only check if the build completes without errors. --- tests/sites/doxygen/extension/conf.py | 10 + tests/sites/doxygen/legacy/conf.py | 11 + tests/sites/templates/doxygen/.doxygen/A.cpp | 44 + .../sites/templates/doxygen/.doxygen/Doxyfile | 2658 +++++++++++++++++ .../templates/doxygen/.sphinx/_toc.yml.in | 10 + tests/sites/templates/doxygen/breathe.md | 7 + tests/sphinx_fixtures.py | 13 +- tests/test_sites.py | 28 +- 8 files changed, 2771 insertions(+), 10 deletions(-) create mode 100644 tests/sites/doxygen/extension/conf.py create mode 100644 tests/sites/doxygen/legacy/conf.py create mode 100644 tests/sites/templates/doxygen/.doxygen/A.cpp create mode 100644 tests/sites/templates/doxygen/.doxygen/Doxyfile create mode 100644 tests/sites/templates/doxygen/.sphinx/_toc.yml.in create mode 100644 tests/sites/templates/doxygen/breathe.md diff --git a/tests/sites/doxygen/extension/conf.py b/tests/sites/doxygen/extension/conf.py new file mode 100644 index 00000000..62bc7f8f --- /dev/null +++ b/tests/sites/doxygen/extension/conf.py @@ -0,0 +1,10 @@ +html_theme = "rocm_docs_theme" +extensions = ["rocm_docs", "rocm_docs.doxygen"] + +doxygen_project = { + "name": "Rocm Docs Core Doxygen Legacy Test Project", + "path": ".doxygen/docBin/xml", +} +doxysphinx_enabled = True + +external_projects_current_project = "a" diff --git a/tests/sites/doxygen/legacy/conf.py b/tests/sites/doxygen/legacy/conf.py new file mode 100644 index 00000000..ce5098f3 --- /dev/null +++ b/tests/sites/doxygen/legacy/conf.py @@ -0,0 +1,11 @@ +from rocm_docs import ROCmDocs + +docs_core = ROCmDocs("Rocm Docs Core Doxygen Legacy Test Project") +docs_core.setup() +docs_core.run_doxygen() +docs_core.enable_api_reference() + +for sphinx_var in ROCmDocs.SPHINX_VARS: + globals()[sphinx_var] = getattr(docs_core, sphinx_var) + +external_projects_current_project = "a" diff --git a/tests/sites/templates/doxygen/.doxygen/A.cpp b/tests/sites/templates/doxygen/.doxygen/A.cpp new file mode 100644 index 00000000..92bafc28 --- /dev/null +++ b/tests/sites/templates/doxygen/.doxygen/A.cpp @@ -0,0 +1,44 @@ +/** + * \brief Root namespace of the example project + * + */ +namespace my_project { + +/** + * \defgroup a Group A + * \brief The A group + * @{ + */ + +/** + * \brief A struct + */ +struct MyStruct { + + /** + * \brief A method + */ + void method(); +}; + +/** + * \brief A function inside the group + */ +void f(); + +/** + * @} + */ + +} // namespace my_project + + +/** + * \defgroup b Group B + */ + +/** + * \ingroup b + * \brief A function + */ +void function_outside_group(); diff --git a/tests/sites/templates/doxygen/.doxygen/Doxyfile b/tests/sites/templates/doxygen/.doxygen/Doxyfile new file mode 100644 index 00000000..b327282c --- /dev/null +++ b/tests/sites/templates/doxygen/.doxygen/Doxyfile @@ -0,0 +1,2658 @@ +# Doxyfile 1.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "My Project" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docBin + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = A.cpp + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to +# YES then doxygen will add the directory of each input to the include path. +# The default value is: YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = ../_doxygen/header.html + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = ../_doxygen/footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = ../_doxygen/stylesheet.css + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = ../_doxygen/extra_stylesheet.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: +# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /