-
Notifications
You must be signed in to change notification settings - Fork 223
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
Myst integration. #403
Conversation
There was a problem hiding this 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Via multi-repo.