Skip to content

Updates to documentation, rtd configurations#400

Merged
bmcfee merged 13 commits intomir-evaluation:mainfrom
bmcfee:doc-updates
Feb 6, 2025
Merged

Updates to documentation, rtd configurations#400
bmcfee merged 13 commits intomir-evaluation:mainfrom
bmcfee:doc-updates

Conversation

@bmcfee
Copy link
Copy Markdown
Collaborator

@bmcfee bmcfee commented Jan 28, 2025

WIP for getting the RTD build to work well and look nice.

Also updates to things like broken links, etc.

@bmcfee
Copy link
Copy Markdown
Collaborator Author

bmcfee commented Feb 5, 2025

Annoyingly, RTD community (ie free) mode does not really support organization-owned repos on github. See: https://me-readthedocs.readthedocs.io/en/latest/commercial/organizations.html

It still "works", see eg https://mir-eval.readthedocs.io/latest/ , but security credentials for webhooks don't work, which means that we can't get doc builds on pull requests. This makes it a real pain to debug doc builds. I suspect we may have to scrap this idea and fall back on self-hosting.

@bmcfee
Copy link
Copy Markdown
Collaborator Author

bmcfee commented Feb 6, 2025

Ok, since RTD won't do doc builds on PR for us, I'm adding a CI workflow to do it for us. We won't get a preview of the build artifact, but it will at least let us know if the doc build fails.

@bmcfee
Copy link
Copy Markdown
Collaborator Author

bmcfee commented Feb 6, 2025

@stefan-balke @craffel I've implemented a restructuring of the doc site that I think should make things a bit easier to navigate. Everything is still essentially accessible from the landing, but submodules each get their own page now so it's not one giant doc.

@craffel
Copy link
Copy Markdown
Collaborator

craffel commented Feb 6, 2025

Looks good, thanks for handling all of this. I know Sphinx conf.py files by convention have lots of lines commented out, but maybe we can avoid adding new commented-out lines?

@bmcfee
Copy link
Copy Markdown
Collaborator Author

bmcfee commented Feb 6, 2025

but maybe we can avoid adding new commented-out lines?

I don't think I added anything new, just fixed some formatting on lines that were pre-existing and commented. But in general I agree, we shouldn't add more than is needed.

@bmcfee
Copy link
Copy Markdown
Collaborator Author

bmcfee commented Feb 6, 2025

Test failures are due to codecov weirdness, still not finding our token. But as everything else is in the green, I'd like to merge this to see how the RTD build looks with the new layout.

@bmcfee bmcfee merged commit a172235 into mir-evaluation:main Feb 6, 2025
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 this pull request may close these issues.

2 participants