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

📖 Remove RTD and add Netlify #1124

Merged
merged 11 commits into from
Apr 17, 2024
Merged

📖 Remove RTD and add Netlify #1124

merged 11 commits into from
Apr 17, 2024

Conversation

choldgraf
Copy link
Collaborator

@choldgraf choldgraf commented Apr 17, 2024

This removes our ReadTheDocs configuration and adds Netlify configuration, because this was much easier and more reliable in getting our docs previews running.

It also:

  • Move environment.yml to requirements.txt (since installing with pypi has less overhead than conda)
  • Adds an example of markdown-based computation

Copy link

netlify bot commented Apr 17, 2024

👷 Deploy Preview for mystmd processing.

Name Link
🔨 Latest commit 0e3c51d
🔍 Latest deploy log https://app.netlify.com/sites/mystmd/deploys/66202d315f93bc0008401d2b

@jupyter-book jupyter-book deleted a comment from netlify bot Apr 17, 2024
@rowanc1 rowanc1 changed the title Remove rtd and add netlify 📖 Remove RTD and add Netlify Apr 17, 2024
@rowanc1 rowanc1 added the documentation Improvements or additions to documentation label Apr 17, 2024
@rowanc1 rowanc1 merged commit 5b99b82 into main Apr 17, 2024
5 checks passed
@rowanc1 rowanc1 deleted the netlify branch April 17, 2024 20:59
@LecrisUT
Copy link
Contributor

A quick comment, RTD workflow parts, I will comment in a separate PR. It would be nice to add badges and CI checks on the main branch to show the new users how they can setup Netlify (and RTD in the future) to work with mystmd

@choldgraf
Copy link
Collaborator Author

I believe that @rowanc1 has already added instructions on how to deploy to netlify here!

https://mystmd.org/guide/deployment-netlify

@LecrisUT
Copy link
Contributor

Indeed, but I think having badges and connecting the Github action for the main branch would also be important to document even if redundant. RTD is quite a common workflow for users of myst-parser and it would be nice to have it documented how they can get similar results in the other hosting providers that (currently) work well with mystmd

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

Successfully merging this pull request may close these issues.

3 participants