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: fixup and get a successful render #1337

Merged
merged 3 commits into from May 7, 2020

Conversation

grahamc
Copy link
Member

@grahamc grahamc commented May 7, 2020

ReadTheDocs uses a very old (1.x) Sphinx, but we're using a 3.x. In order to update it, we have to create a requirements.txt and point RTD to it with a file in the root of the project. A bit ugly, but at least we can do it! (Though it'd be cool if they supported pyproject / poetry.)

To keep the requirements.txt consistent, CI now verifies that it matches the poetry.lock (and also that poetry.lock is up to date with pyproject.toml.)

@grahamc
Copy link
Member Author

grahamc commented May 7, 2020

I created my own project on RTD to test this, here it is rendered: https://nixops-testing.readthedocs.io/en/fixup-rtd/

@grahamc grahamc marked this pull request as ready for review May 7, 2020 13:38
@grahamc grahamc requested a review from adisbladis May 7, 2020 13:38
@grahamc grahamc changed the title ReadTheDocs: fixup ReadTheDocs: fixup and get a successful render May 7, 2020
@adisbladis adisbladis merged commit 7a13631 into NixOS:master May 7, 2020
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.

None yet

2 participants