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

📚 DOCS: Full update #717

Merged
merged 9 commits into from
Mar 1, 2023
Merged

📚 DOCS: Full update #717

merged 9 commits into from
Mar 1, 2023

Conversation

chrisjsewell
Copy link
Member

Just about ready for a release!

@codecov
Copy link

codecov bot commented Feb 23, 2023

Codecov Report

Patch coverage: 92.80% and project coverage change: +0.01 🎉

Comparison is base (7692f87) 89.93% compared to head (b4fa8a8) 89.95%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #717      +/-   ##
==========================================
+ Coverage   89.93%   89.95%   +0.01%     
==========================================
  Files          23       23              
  Lines        2892     2967      +75     
==========================================
+ Hits         2601     2669      +68     
- Misses        291      298       +7     
Flag Coverage Δ
pytests 89.95% <92.80%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
myst_parser/config/main.py 86.03% <ø> (ø)
myst_parser/sphinx_ext/myst_refs.py 88.76% <ø> (ø)
myst_parser/mdit_to_docutils/base.py 92.67% <86.95%> (-0.27%) ⬇️
myst_parser/mdit_to_docutils/sphinx_.py 95.90% <94.54%> (-1.83%) ⬇️
myst_parser/__init__.py 100.00% <100.00%> (ø)
myst_parser/mocking.py 84.82% <100.00%> (ø)
myst_parser/parsers/docutils_.py 82.72% <100.00%> (+1.90%) ⬆️
myst_parser/sphinx_ext/main.py 89.74% <100.00%> (ø)
myst_parser/warnings_.py 96.15% <100.00%> (+0.07%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@rowanc1 rowanc1 left a comment

Choose a reason for hiding this comment

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

Took a look through all the docs, block attrs and inline attributes look great. The hover-tool tips are great, as you know I am a big fan of showing contextual information. Also was funny to see some of the Shakespeare quote and poems I chose making their way back here.

Only concern in this PR is around the mixing of directive names and class names. I think that is fine if we adopt a widely used existing syntax (e.g. support quarto-style callouts). However, I don't think that we should suggest another way to do admonitions without addressing some of the existing confusions. e.g. in jupyter-book/myst-spec#49. @mmcky @choldgraf and I have been chatting about this recently, and some of our thoughts are going to be clarified in the next few weeks!

Can we please either (1) put a warning around this saying we might deprecate it; or (2) remove the functionality.

I would love to discuss how directives and class-names interact in a specific MEP, but I think that needs to come after we decide as a team on the block and inline syntax!

docs/syntax/admonitions.md Outdated Show resolved Hide resolved
@chrisjsewell
Copy link
Member Author

Just to link, as we discussed on slack; I have tried to kick start some conversation here, as to a shorthand to essentially specify a role/directive in attribute syntax: jgm/djot#146

@chrisjsewell chrisjsewell force-pushed the myst-examples branch 2 times, most recently from 28cad78 to 2c15fb6 Compare February 23, 2023 17:58
This is a caption in **Markdown**
:::
```
::::{myst-example}
Copy link

Choose a reason for hiding this comment

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

I think the docs should probably use sth like:

![fishy](img/fun-fish.png)

For an example. Hopefully most people use the md image syntax, not the HTML one :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Done thanks!

The live preview now renders only the body HTML, and inherits the outer theme
@rowanc1 rowanc1 dismissed their stale review February 28, 2023 19:32

Admonitions removed, can take another pass when this is closer to merge, please ping me!

@chrisjsewell chrisjsewell force-pushed the myst-examples branch 2 times, most recently from 4b1bc2c to d6d1cd0 Compare March 1, 2023 00:44
@chrisjsewell chrisjsewell merged commit de31423 into master Mar 1, 2023
@chrisjsewell chrisjsewell deleted the myst-examples branch March 1, 2023 06:39
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.

None yet

3 participants