-
Couldn't load subscription status.
- Fork 110
Update documentation on extends #2362
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
base: main
Are you sure you want to change the base?
Conversation
|
…the finger pointing down
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.
I think the docs look good to me - it's great to improve the docs and discoverability around these workflows! I noticed it seems like we're updating a dependency here, is that intentional? Could you roll that back into a separate PR so we aren't doing too many things in one go?
docs/table-of-contents.md
Outdated
| :::: | ||
|
|
||
| ## Using extend for a long ToC | ||
| In some cases the ToC becomes very long, where it would be more convenient to create a separate ToC file. This can be done using [extends](#composing-myst-yml). |
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.
| In some cases the ToC becomes very long, where it would be more convenient to create a separate ToC file. This can be done using [extends](#composing-myst-yml). | |
| If your Table of Contents is very long, it can make your `myst.yml` difficult to read and maintain. You can use [`extends:` functionality](#composing-myst-yml) to store the ToC structure in a separate file, allowing you to re-use it in a modular way. |
Co-authored-by: Chris Holdgraf <[email protected]>
Co-authored-by: Chris Holdgraf <[email protected]>
Revert version number to 1.0.12.
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.
I was reviewing, when I realized that almost all the diffs I'm looking at are reformatting. But some do contain content diffs. It's probably best to separate these out in the future.
I'll continue reviewing later, skipping the formatting and focusing on the extends section.
| @@ -1,7 +0,0 @@ | |||
| --- | |||
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.
Unintended change?
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.
This got in with a pull from angus somehow. Have discussed it with Chris already.
Yeah, sorry, was reading the documents and thought it would be easy to format it all along. Not thinking about the review! |
Co-authored-by: Stefan van der Walt <[email protected]>
Co-authored-by: Stefan van der Walt <[email protected]>
Co-authored-by: Stefan van der Walt <[email protected]>
Co-authored-by: Stefan van der Walt <[email protected]>
Included the use of extends for