GitLab now enforces expiry dates on tokens that originally had no set expiration date. Those tokens were given an expiration date of one year later. Please review your personal access tokens, project access tokens, and group access tokens to ensure you are aware of upcoming expirations. Administrators of GitLab can find more information on how to identify and mitigate interruption in our documentation.
This MR contributes various refactorings and improvements to the Sphinx documentation of pystencils.
Delete doc subfolder containing the old documentation tree
Introduce sphinx-design elements for more pleasing visuals
Create a welcome page with general information about the project
Start constructing a comprehensive reference guide and API reference
Use sphinx.ext.autosummary where appropriate to declutter API listings into several subpages
Set the build-documentation CI task to fail when errors occur during sphinx-build
Fix various reference errors in docstrings throughout the project
Started writing a migration guide for downstream code from 1.3.x. to 2.0
This MR exclusively touches documentation files and docstrings. When reviewing, it might be sensible to focus on the generated doc pages available in the pipeline artifacts.
There is still a lot of work to do to bring the documentation up to standards; this set of changes is by no means complete.
