ricardogr07/purkinje-uv

AI Summary: This issue aims to increase the test coverage of the `purkinje_uv` project to at least 90% using `pytest-cov`, thereby improving code quality and enabling safer refactors. Key tasks include integrating coverage checks into CI, writing extensive unit and parameterized tests for critical paths and edge cases, and optimizing test suite speed by mocking PyVista calls.

AI Summary: Improve the documentation for the PurkinjeUV Python package by fixing Sphinx build warnings, enhancing the layout of the index page for better readability and user experience, adding project metadata (description, keywords, title), and incorporating a logo and favicon. The goal is to create a more engaging and user-friendly documentation experience while ensuring a clean build process.

AI Summary: Set up versioned documentation for the PurkinjeUV Python package using sphinx-multiversion. This involves choosing a suitable tool (likely sphinx-multiversion), configuring a deployment branch (gh-pages), adding a version selector dropdown to the documentation's UI, and updating the workflow to automatically deploy new versions upon tagging releases. The goal is to allow users to access documentation for different versions of the package.

AI Summary: Update the README.md file for the PurkinjeUV project by adding a GitHub Pages badge linking to the project documentation, creating a 'Documentation' section with a link to the homepage, and adding a 'Getting Started' section linking to the documentation's introduction or a first example.