Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

We are relying on old software for testing and documentation #416

Open
mnlevy1981 opened this issue Feb 14, 2023 · 0 comments
Open

We are relying on old software for testing and documentation #416

mnlevy1981 opened this issue Feb 14, 2023 · 0 comments

Comments

@mnlevy1981
Copy link
Collaborator

As I noted in #415, the continuous integration via Github Actions fails if we try to run it on any version of python newer than 3.9:

we will need to change the setup of the documentation to move to 3.10 and then update pylint to get to 3.11 (or beyond).

Basically, we are relying on a very old software stack to build our documentation:

pylint==1.9.2
isort<5
Sphinx==1.7.5
sphinxcontrib-bibtex==0.4.0
pybtex==0.22
git+https://github.com/marbl-ecosys/sphinx_rtd_theme.git@version-dropdown

Sphinx 1.7.5 is from May, 2018, and pylint 1.9.2 is only a month newer. We have pinned Sphinx because I have assumed that newer versions will render our webpages slightly differently, and have wanted to keep the webpage consistent from build to build. We have pinned pylint because different newer versions flag slightly different style choices than older ones, and I haven't wanted to update our code to avoid those (or update pylintrc to ignore them).

That said, the code that pylint checks was written at a time when we needed to support python 2 and python 3. I agree with @klindsay28's comment in #415 (comment) that we only need to maintain python 2 support if CESM does, and I believe CESM does not... so maybe we should update to the most recent pylint and actually clean up the lines of code that are written in the py2 style?

This is an extremely low priority, but I'll come back to this issue the next time our CI breaks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant