From f1121b8bac0728fb98978c1ee298e9ef859faaaa Mon Sep 17 00:00:00 2001 From: Karolina Surma Date: Thu, 22 Aug 2024 11:20:13 +0200 Subject: [PATCH 01/21] Add a smoke test --- .fmf/version | 1 + plan.fmf | 5 +++++ tests/smoke/main.fmf | 9 +++++++++ tests/smoke/source/conf.py | 5 +++++ tests/smoke/source/index.rst | 15 +++++++++++++++ 5 files changed, 35 insertions(+) create mode 100644 .fmf/version create mode 100644 plan.fmf create mode 100644 tests/smoke/main.fmf create mode 100644 tests/smoke/source/conf.py create mode 100644 tests/smoke/source/index.rst diff --git a/.fmf/version b/.fmf/version new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/.fmf/version @@ -0,0 +1 @@ +1 diff --git a/plan.fmf b/plan.fmf new file mode 100644 index 0000000..94cb32d --- /dev/null +++ b/plan.fmf @@ -0,0 +1,5 @@ +discover: + how: fmf +execute: + how: tmt + diff --git a/tests/smoke/main.fmf b/tests/smoke/main.fmf new file mode 100644 index 0000000..80e8276 --- /dev/null +++ b/tests/smoke/main.fmf @@ -0,0 +1,9 @@ +summary: run the basic documentation build +test: | + sphinx-build -M html source/ build/ && + grep '
' build/html/index.html && + grep '

Test docfile' build/html/index.html && + rm -rf build/ +require: + - python3-sphinx + - python3-sphinx-theme-alabaster diff --git a/tests/smoke/source/conf.py b/tests/smoke/source/conf.py new file mode 100644 index 0000000..3c43798 --- /dev/null +++ b/tests/smoke/source/conf.py @@ -0,0 +1,5 @@ +project = 'Test' +copyright = '2024, Test' +author = 'Test' +release = '0.3.0' +html_theme = 'alabaster' diff --git a/tests/smoke/source/index.rst b/tests/smoke/source/index.rst new file mode 100644 index 0000000..4d6fdff --- /dev/null +++ b/tests/smoke/source/index.rst @@ -0,0 +1,15 @@ +Test docfile +============ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` From 383e230ab05de6c779bbae50f70fc5c2fcc4e69e Mon Sep 17 00:00:00 2001 From: Karolina Surma Date: Fri, 20 Sep 2024 16:10:35 +0200 Subject: [PATCH 02/21] Tests sphinx extensions with the package Tested extensions: - python-sphinx-theme-alabaster - python-sphinx_rtd_theme - python-sphinxcontrib-jquery The tested extensions are the one that we pull to CentOS Stream/RHEL. --- tests/include-sphinxcontrib-jquery/main.fmf | 11 +++++++++++ tests/include-sphinxcontrib-jquery/source/conf.py | 7 +++++++ .../source/index.rst | 0 tests/{smoke => smoke-alabaster}/main.fmf | 1 + tests/{smoke => smoke-alabaster}/source/conf.py | 0 tests/smoke-alabaster/source/index.rst | 15 +++++++++++++++ tests/smoke-rtd-theme/main.fmf | 11 +++++++++++ tests/smoke-rtd-theme/source/conf.py | 8 ++++++++ tests/smoke-rtd-theme/source/index.rst | 15 +++++++++++++++ 9 files changed, 68 insertions(+) create mode 100644 tests/include-sphinxcontrib-jquery/main.fmf create mode 100644 tests/include-sphinxcontrib-jquery/source/conf.py rename tests/{smoke => include-sphinxcontrib-jquery}/source/index.rst (100%) rename tests/{smoke => smoke-alabaster}/main.fmf (83%) rename tests/{smoke => smoke-alabaster}/source/conf.py (100%) create mode 100644 tests/smoke-alabaster/source/index.rst create mode 100644 tests/smoke-rtd-theme/main.fmf create mode 100644 tests/smoke-rtd-theme/source/conf.py create mode 100644 tests/smoke-rtd-theme/source/index.rst diff --git a/tests/include-sphinxcontrib-jquery/main.fmf b/tests/include-sphinxcontrib-jquery/main.fmf new file mode 100644 index 0000000..e447827 --- /dev/null +++ b/tests/include-sphinxcontrib-jquery/main.fmf @@ -0,0 +1,11 @@ +summary: run the basic documentation build +test: | + sphinx-build -M html source/ build/ && + grep '