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: use myst-parser for md #561

Merged
merged 1 commit into from
Jan 12, 2022
Merged

Conversation

henryiii
Copy link
Collaborator

@henryiii henryiii commented Jan 11, 2022

Closes #559 again.

See readthedocs/recommonmark#221 - recommonmark has been sun-setted, myst-parser is the replacement.

@FollowTheProcess
Copy link
Collaborator

LGTM, might it be worth another PR build to check? @dhermes

@henryiii
Copy link
Collaborator Author

I think we were just merging then trying to rebuild readthedocs, since PR docs builds are not working. But this does work both locally and with the GHA docs build.

@cjolowicz cjolowicz merged commit c459e48 into wntrblm:main Jan 12, 2022
@henryiii
Copy link
Collaborator Author

@henryiii
Copy link
Collaborator Author

So latest is working, stable need to be rebuilt. @dhermes could you retrigger stable, probably pointing it at main temporarily? Not sure the best way to do that.

@henryiii henryiii deleted the henryiii/fix/docs2 branch January 12, 2022 15:44
@dhermes
Copy link
Collaborator

dhermes commented Jan 12, 2022

The point of stable is that it points at a released version of the code / docs. Not really sure what a good strategy is for that (short of cutting a release).

@henryiii
Copy link
Collaborator Author

I believe no changes have been made since the last release, so rebuilding with the current main would be identical to the last release. (As long as you don't leave it on current main).

@cjolowicz
Copy link
Collaborator

Another possibility would be to make a post-release, 2022.1.7.post1. That would trigger the stable build, and give us a PyPI release that's clearly marked as a minor correction without user-visible changes.

@henryiii
Copy link
Collaborator Author

Post releases should be metadata only (which is pretty much exactly what this is - docs), so that would also be fine. Though I'd still think that's a little overkill, the point of stable is to have docs for the latest release that don't also include features/changes added since the latest release, not that they have to be tied to an exact tag, but yes, it's fine.

@henryiii
Copy link
Collaborator Author

(In pybind11 we have a stable branch and that's what the stable docs builds from, which allows us to make docs fixes after a release if we really need to - thought usually we don't)

@DiddiLeija DiddiLeija mentioned this pull request Jan 13, 2022
@cjolowicz cjolowicz mentioned this pull request Jan 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

readthedocs broken
4 participants