Adopt copier template #52
Conversation
Using default Sphinx documentation layout. Added MacOS and Windows to default CI. Made some changes to Ruff configuration as it seems the template is out of date.
Includes work to make old .rst docs work with .md format Includes a fix in conf.py for broken autodoc_type_aliases
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
Also fixes the trivial changes that these changes highlight. Note there are more complex linting errors spotted...
It's useful purely for the --version check in CI.
AlexanderWells-diamond
force-pushed
the
adopt_copier_template
branch
from
003647a
to
627f3f2
Compare
|
@coretl The remaining errors are a handful of new linting errors, and a single test failure. The linting errors are mostly regarding accessing private members, which would require actual code changes to fix. The one test failure is strange - it's completely repeatable, but only after the copier template has been applied. I can't see any obvious packages that would cause it (I tried rolling back How do you want me to handle these issues? |
AlexanderWells-diamond
force-pushed
the
adopt_copier_template
branch
from
a6f1009
to
6c7c3da
Compare
|
After discussion with @coretl I mostly ignored the linting errors, and then spent some time investigating the test failure and applying a (hacky) fix to it. This is now ready for review. |
Co-authored-by: Tom C (DLS) <[email protected]>
A fair amount of manual work went in to fixing the Docs, to make the existing .rst work with the new .md format. The new documentation should be reviewed to check it is sensible.