Version 1.16-dev #1147
Version 1.16-dev #1147
Conversation
| @@ -1,6 +1,14 @@ | |||
| Jupytext ChangeLog | |||
| ================== | |||
|
|
|||
| 1.16.0-dev (2023-10-??) | |||
There was a problem hiding this comment.
Can you move this to top-level Changelog.md and use include to link to it? Here's an example of using include.
The idea is to have it in keep-a-changelog form so it is easier to incrementally add changelog
There was a problem hiding this comment.
Oh great! Actually I could use that for the README.md too (index.md is almost a verbatim copy of ../README.md)
docs/index.md
Outdated
| @@ -1,4 +1,4 @@ | |||
|  | |||
|  | |||
There was a problem hiding this comment.
Hopefully this one reports as passed. If not we can look at how to report only the las job in the CI
mwouts
force-pushed
the
version_1.16-dev
branch
from
aa20563 to
de82dfb
Compare
There was a problem hiding this comment.
Cheers @mwouts for working on doc changes. LGTM, I left couple of minor comments.
I see you removed references to Notebook in the docs as we removed "legacy" nbextension. But with Notebook >=7, we can use the extension exactly the same way as we do with JupyterLab 4, i.e., from command palette. Maybe adding a line saying that somewhere in the docs can be useful?
I see the value of feature proposed in #1095. I will try to work on it if someone is not already on it. Let me know.
docs/CHANGELOG.md
Outdated
|
|
||
| **Changed** | ||
| - Jupytext is now configured with `pyproject.toml` and built with `hatch`. The layout has been reorganised to follow `src-layout` ([#1140](https://github.com/mwouts/jupytext/issues/1140)). This outstanding update was contributed by [Mahendra Paipuri](https://github.com/mahendrapaipuri). | ||
| - The extension for Jupyter Notebook (the Jupytext Menu) has been removed. |
There was a problem hiding this comment.
Maybe specifying Notebook version is more clear.
| - The extension for Jupyter Notebook (the Jupytext Menu) has been removed. | |
| - The legacy extension for Jupyter Notebook <=6 (the Jupytext Menu) has been removed. |
There was a problem hiding this comment.
Yes sure! I've added this change to CHANGELOG.md (the file has been moved at the root now)
with the include directive
Co-authored-by: Mahendra Paipuri <[email protected]>
Yes that's a good point! I'll add this
Yes the option to create text notebooks directly would be very useful indeed! The idea was suggested by @parmentelat so maybe we can first check with him first if he has anything he wants to share. Also do you think the command palette is the way to go, or would you recommend to also make these commands available in a menu as for the legacy notebook extension? |
| @@ -1,6 +1,14 @@ | |||
| Jupytext ChangeLog | |||
| ================== | |||
|
|
|||
| 1.16.0-dev (2023-10-??) | |||
There was a problem hiding this comment.
I recommend using a <!-- SPHINX-START --> tag to change the header. This is particularly useful for the README.md to filter out the badges. Another cool feature is to use markdown reference-style links to correct the links. It should work with myst-parser
There was a problem hiding this comment.
Oh interesting. In index.md we currently have the badges so I was thinking of keeping them, but sure I will filter out the logo. Yes I've seen about the links and it's very useful to convert the links from the README.md where there point to docs, to index.md where they are local.
In this PR we update the documentation following #1140
Closes #1139
@LecrisUT @mahendrapaipuri let me know if you see anything else to mention in the documentation.