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

Myst integration. #403

Closed
wants to merge 5 commits into from
Closed

Myst integration. #403

wants to merge 5 commits into from

Conversation

bryanressler-idmod
Copy link
Contributor

Via multi-repo.

@github-actions
Copy link

github-actions bot commented Jul 28, 2023

Test Results

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0

Results for commit 8262e63.

♻️ This comment has been updated with latest results.

Copy link
Member

@cliffckerr cliffckerr 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 so far, I know this is still in progress, just a quick comment on a file

@@ -1,20 +0,0 @@
# Covasim docs
Copy link
Member

Choose a reason for hiding this comment

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

Just a quick comment that this file shouldn't be deleted -- this is documentation on the docs, and is intentionally excluded from the build. It uses .md instead of .rst intentionally so it shows up when you view the folder, but isn't included in the built docs. It could also be excluded manually, of course.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep, I agree. Just doing a lot of experimentation on this PR to figure out why the build was breaking. I suspected it might be because md files were ignored before myst was added, but now they are considered a source file that's missing from the TOC. With myst implemented, we can add it to the exclude list in conf.py.

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.

3 participants