Include changelog in docs #2161
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mathbunnyru
commented
Oct 20, 2024
docs/using/changelog_link.md
Outdated
| @@ -0,0 +1,5 @@ | |||
| ```{include} ../../CHANGELOG.md | |||
There was a problem hiding this comment.
This seems to be a standard way of including a file outside of the docs folder
mathbunnyru
commented
Oct 20, 2024
| ## 2024-10-09 | ||
|
|
||
| Affected: users building a custom set of images | ||
|
|
||
| - **Breaking:** Rename: `ROOT_CONTAINER`->`ROOT_IMAGE`, `BASE_CONTAINER`->`BASE_IMAGE` ([#2154](https://github.com/jupyter/docker-stacks/pull/2154), [#2155](https://github.com/jupyter/docker-stacks/pull/2155)) | ||
| - **Breaking:** Rename: `ROOT_CONTAINER`->`ROOT_IMAGE`, `BASE_CONTAINER`->`BASE_IMAGE` ([#2154](https://github.com/jupyter/docker-stacks/issues/2154), [#2155](https://github.com/jupyter/docker-stacks/pull/2155)) |
There was a problem hiding this comment.
Fun fact: sphinx linkcheck now works on the changelog file as well!
|
This is how it looks like: https://jupyter-docker-stacks--2161.org.readthedocs.build/en/2161/using/changelog_link.html |
I don't like that the file name is |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Issue ticket if applicable
Checklist (especially for first-time contributors)