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

Documentation no longer updates automatically #1185

Closed
zorun opened this issue Jul 13, 2023 · 6 comments
Closed

Documentation no longer updates automatically #1185

zorun opened this issue Jul 13, 2023 · 6 comments

Comments

@zorun
Copy link
Collaborator

zorun commented Jul 13, 2023

It says "Failed" on https://readthedocs.org/projects/ihatemoney/builds/

This happened before in #653

Maybe we should update documentation from the Github CI, so that we would be aware when it breaks.

@zorun
Copy link
Collaborator Author

zorun commented Jul 14, 2023

Still not working, different issue: https://readthedocs.org/projects/ihatemoney/builds/21301509/

@Glandos apparently the sphinx-rtd-theme from readthedocs does not support Sphinx 7:

I see you updated Sphinx #1172 because of docutils, why do we need a newer docutils?

@zorun zorun reopened this Jul 14, 2023
@zorun
Copy link
Collaborator Author

zorun commented Jul 14, 2023

To be honest (it's definitely not against you @Glandos ), I'm really fed up with dependabot trying to update everything to the latest version, even if we don't actually need it... (e.g. not for security issues)

But maybe that's just me being conservative :D

@Glandos
Copy link
Member

Glandos commented Jul 14, 2023

I think I should also refrain from clicking on "Update" each time I am notified of something just to have a dopamine shot.

I think that:

  • updating "real project" dependencies is good. E.g. SQLAlchemy, Flask, etc.
  • updating "dev" dependencies should be done more peacefully. Breaking the build process is easy, fixing it is tedious, and we don't spend enough time on this project for that.

For this specific issue, I am bit hesitant. We can downgrade Sphinx/docutils after all, it won't impact any users. It seems that waiting for a new release of sphinx_rtd_theme is like waiting for the rain in the hot summer of Spain: it will happen, you don't know when.

@zorun
Copy link
Collaborator Author

zorun commented Jul 14, 2023

Totally agree on saving our time, we don't have enough to spend on tedious/pointless fixes :)

If updating sphinx and docutils has no added value, I'm all for downgrading to older versions that work with readthedocs. After all, that's why we pin versions.

@almet
Copy link
Member

almet commented Jul 14, 2023

Hi folks! I agree with you both on that. Regarding the autoupdate of readthedocs. It used to be configured directly on readthedocs, with a hook that happened when we tagged a new version.

It's been a while, so maybe it's not working anymore, though. Maybe nowadays it's better to use the CI for this? Not sure, do you do this on others projects?

@zorun
Copy link
Collaborator Author

zorun commented Jul 28, 2023

@Glandos do you have time to downgrade Sphinx to fix this issue?

TomRoussel pushed a commit to TomRoussel/ihatemoney that referenced this issue Mar 2, 2024
@almet almet closed this as completed Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants