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

Docs building is broken in Read the Docs #3585

Closed
3 tasks done
mathbunnyru opened this issue Nov 8, 2024 · 7 comments · Fixed by #3586
Closed
3 tasks done

Docs building is broken in Read the Docs #3585

mathbunnyru opened this issue Nov 8, 2024 · 7 comments · Fixed by #3586

Comments

@mathbunnyru
Copy link
Contributor

Troubleshooting docs

  • My problem is not solved in the Troubleshooting docs

Anaconda default channels

  • I do NOT use the Anaconda default channels (pkgs/* etc.)

How did you install Mamba?

Mambaforge or latest Miniforge

Search tried in issue tracker

docs, sphinx

Latest version of Mamba

  • My problem is not solved with the latest version

Tried in Conda?

Not applicable

Describe your issue

It seems that for a while docs building has been broken.
https://app.readthedocs.org/projects/mamba/builds/

The latest successful build was on 7th October.
It is also the day when Read the Docs Addons were enabled by default: https://about.readthedocs.com/blog/2024/07/addons-by-default/

mamba info / micromamba info

No response

Logs

No response

environment.yml

No response

~/.condarc

No response

@mathbunnyru mathbunnyru changed the title Docs building is broken Docs building is broken in Read the Docs Nov 8, 2024
@mathbunnyru
Copy link
Contributor Author

I also think the RTD should be configured to be run in branches: https://docs.readthedocs.io/en/stable/pull-requests.html
As far as I remember the admin of RTD has to click one checkbox in the Admin page - it makes the dev's life so much easier when there are documentation changes.

@mathbunnyru
Copy link
Contributor Author

I think this is a major issue, and it's not good that there is no automatic checking the docs are fine

@mathbunnyru
Copy link
Contributor Author

I tried to start contributing to this project, for example, and docs mention Taskfile: https://mamba.readthedocs.io/en/latest/developer_zone/dev_environment.html

But it has been removed 3 weeks ago: #3544

@mathbunnyru
Copy link
Contributor Author

I think I found the reason.
7th October is when Python 3.13 was released and imghdr has been removed in this release.

For some reason, rtd installs python 3.13, but also installs pretty old sphinx 5.3, which uses imghdr somewhere in its internals.

@mathbunnyru
Copy link
Contributor Author

I've also checked how to enable building docs in PRs.
Just go to https://readthedocs.org/dashboard/mamba/edit/ (you need to be logged in and have admin access to RTD project, I don't have it), click near Build pull requests for this project, and then `Save.

This is how it's going to look like in PRs: mathbunnyru#1

@mathbunnyru
Copy link
Contributor Author

I've also checked how to enable building docs in PRs. Just go to https://readthedocs.org/dashboard/mamba/edit/ (you need to be logged in and have admin access to RTD project, I don't have it), click near Build pull requests for this project, and then `Save.

This is how it's going to look like in PRs: mathbunnyru#1

@Hind-M I highly recommend you doing this, it will prevent this problem from happening again and it greatly helps to review docs PR changes (you can inspect not just the source code, but the built pages as well).

@Hind-M
Copy link
Member

Hind-M commented Nov 13, 2024

Yes absolutely, I will pass the info to the admin people who have the rights on RTD, thanks!

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

Successfully merging a pull request may close this issue.

2 participants