✨ Test Documentation code snippets

[je-cook]

Description

This is a possible addition to our CI suite that tests all code snippets in documentation and docstrings.
The documentation tests cant be run in parallel currently because each file shares a namespace.

The choice of using Sybil needs to be discussed but so far looks promising

Interface Changes

Checklist

I confirm that I have completed the following checks:

• Tests run locally and pass pytest tests --reactor
• Code quality checks run locally and pass pre-commit run --from-ref develop --to-ref HEAD
• Documentation built locally and checked sphinx-build -W documentation/source documentation/build

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.61%. Comparing base (2a2c8b0) to head (85be89b).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3386      +/-   ##
===========================================
+ Coverage    74.51%   74.61%   +0.10%     
===========================================
  Files          230      230              
  Lines        26813    26812       -1     
===========================================
+ Hits         19979    20007      +28     
+ Misses        6834     6805      -29     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

⚠️ Warning Report

Found 0 new warnings, 0 fixed warnings. 🎉

All warnings (5)

On runtest

• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/ufl/core/expr.py:275: DeprecationWarning: Expr.ufl_domain() is deprecated, please use extract_unique_domain(expr) instead.
• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/basix/ufl.py:1909: DeprecationWarning: Converting elements created in UFL to Basix elements is deprecated. You should create the elements directly using basix.ufl.element instead
• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/ffcx/element_interface.py:23: DeprecationWarning: Use of elements created by UFL is deprecated. You should create elements directly using Basix.
• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/ffcx/element_interface.py:26: DeprecationWarning: Converting elements created in UFL to Basix elements is deprecated. You should create the elements directly using basix.ufl.element instead

On collect

• /home/runner/miniconda3/envs/bluemira/lib/python3.10/site-packages/ufl/core/ufl_type.py:56: DeprecationWarning: attach_operators_from_hash_data deprecated, please use UFLObject instead.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[oliverfunk]

Great feature and getting the docs more up to scratch!