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.

Sign up for GitHub

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

Jump to bottom

Convert docs to MyST #203

Merged
merged 2 commits into from
Mar 10, 2022
Merged

Convert docs to MyST #203

merged 2 commits into from
Mar 10, 2022

Conversation

jtpio
Copy link
Member

@jtpio jtpio commented Mar 10, 2022

This should make authoring docs easier with Markdown.

  • Add / update the documentation

@jtpio jtpio added the documentation Improvements or additions to documentation label Mar 10, 2022
@pierrepo
Copy link
Contributor

I ❤️ this idea

@jtpio jtpio marked this pull request as ready for review March 10, 2022 11:51
@jtpio
Copy link
Member Author

jtpio commented Mar 10, 2022

This looks good locally and CI is passing.

Not sure why the ReadTheDocs PR preview is not showing up here, although it should be enabled (#201).

@jtpio jtpio requested a review from pierrepo March 10, 2022 11:52
pierrepo
pierrepo reviewed Mar 10, 2022
View reviewed changes
Copy link
Contributor

@pierrepo pierrepo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks @jtpio

I let you merge.

@jtpio
Copy link
Member Author

jtpio commented Mar 10, 2022

OK thanks @pierrepo for the review.

Let me know if you notice any issue when the latest docs are built.

@jtpio jtpio merged commit 5586f13 into plasmabio:master Mar 10, 2022
@jtpio jtpio deleted the convert-docs-md branch March 10, 2022 13:44
@jtpio
Copy link
Member Author

jtpio commented Mar 10, 2022

Not sure why the ReadTheDocs PR preview is not showing up here, although it should be enabled (#201).

Ah so for references the docs seem to be built: https://plasmabio--203.org.readthedocs.build/en/203/overview/index.html

But the check doesn't show in the list of GitHub checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pierrepo pierrepo pierrepo left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jtpio @pierrepo