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

Use ReadTheDocs #249

Open
abkfenris opened this issue May 25, 2023 · 2 comments
Open

Use ReadTheDocs #249

abkfenris opened this issue May 25, 2023 · 2 comments

Comments

@abkfenris
Copy link
Contributor

Currently we're using Github Pages for hosting and Netlify for PR previews. We keep having issues due to Netlify's Python environment, and it's lack of support for Conda making our packages fall out of sync.

ReadTheDocs now supports Conda/Mamba, so we could simplify our environment, and have the same service manage the build and PR previews.

I remember we had some discussion about RTD before, and I can't remember exactly why we didn't use them and instead built our own versioning scheme. Was it due to the advertising? We can opt it out of advertising by someone getting a membership, which I just tried for Xpublish.

To get our existing old sites, we would probably want to tag the desired commits, then use post_build customization to pull those in. The other place to customize might be to use single version mode.

xref: #237 @emiliom @ocefpaf

@ocefpaf
Copy link
Member

ocefpaf commented May 25, 2023

Was it due to the advertising?

I don't think we discussed that. BTW, I don't have a strong opinion on it. I never saw the appeal of RTD docs b/c it used to be quite complicated to use conda with it. That seems to have changed so it may be a nice option now.

@emiliom
Copy link
Member

emiliom commented May 30, 2023

I'm good with whatever you two recommend, be it RTD or status quo. As long as existing capabilities are preserved, and you do all the work 😜 . Otherwise, we could wait until after OHW23.

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

No branches or pull requests

3 participants