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

Readthedocs? #241

Closed
bmcfee opened this issue Mar 1, 2017 · 9 comments · Fixed by #399
Closed

Readthedocs? #241

bmcfee opened this issue Mar 1, 2017 · 9 comments · Fixed by #399
Assignees
Labels
Milestone

Comments

@bmcfee
Copy link
Collaborator

bmcfee commented Mar 1, 2017

Any interest in setting mir_eval up on rtd? It would be nice to have automatic doc builds for PRs, if nothing else.

@bmcfee bmcfee added the question label Mar 1, 2017
@craffel
Copy link
Collaborator

craffel commented Mar 3, 2017

Sounds like a good idea to me.

@bmcfee
Copy link
Collaborator Author

bmcfee commented Mar 4, 2017

Good project for docathon this coming week. I'll take a crack at it probably around wednesday.

@bmcfee bmcfee added this to the 0.5 milestone Mar 4, 2017
@bmcfee
Copy link
Collaborator Author

bmcfee commented Mar 7, 2017

Hrm, looks like only the project owner can set up the integration. 😢

@bmcfee bmcfee modified the milestones: 0.5, 0.8 Mar 13, 2024
@bmcfee
Copy link
Collaborator Author

bmcfee commented Aug 16, 2024

Blocked by #375

@bmcfee
Copy link
Collaborator Author

bmcfee commented Jan 27, 2025

RTD integration is now working, but the sphinx configs need some work to get autodoc running again.

@stefan-balke
Copy link
Contributor

Is this one-page layout up for debate or could we organize it in topics? IMHO, would be easier to get to the information needed. However, CTRL+F one a single page is also charming in a way.

What you think?

@bmcfee
Copy link
Collaborator Author

bmcfee commented Jan 28, 2025

I would absolutely be in favor of moving to a modern layout and RTD theme. I think our docs are verbose enough that a one-pager is pretty unwieldy.

@bmcfee
Copy link
Collaborator Author

bmcfee commented Feb 6, 2025

Ok, I think we're in business: https://mir-eval.readthedocs.io/latest/

Closing this out. Final step will be to modify our gh-pages to point to the rtd build instead.

@bmcfee bmcfee closed this as completed Feb 6, 2025
@stefan-balke
Copy link
Contributor

Looks good, thanks for picking this up!

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

Successfully merging a pull request may close this issue.

3 participants