Skip to content

Conversation

@FreekPols
Copy link

Included the use of extends for

  • export to pdf, including all options in an export.yml file
  • create a toc.yml file for a very long toc

@changeset-bot
Copy link

changeset-bot bot commented Oct 20, 2025

⚠️ No Changeset found

Latest commit: 0e4a08f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 20, 2025
Copy link
Collaborator

@choldgraf choldgraf left a 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?

::::

## 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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Collaborator

@stefanv stefanv left a 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 @@
---
Copy link
Collaborator

Choose a reason for hiding this comment

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

Unintended change?

Copy link
Author

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.

@FreekPols
Copy link
Author

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.

Yeah, sorry, was reading the documents and thought it would be easy to format it all along. Not thinking about the review!

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants