Skip to content

Fix docs #10591

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

Merged
merged 1 commit into from
Aug 1, 2023
Merged

Fix docs #10591

Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/user/guides/jupyter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ are by far the most widely used for historical reasons.

However, to compensate some of the disadvantages of the ``.ipynb`` format
(like cumbersome integration with version control systems),
`jupytext`_ offers :doc:`other formats <jupytext:formats>`
`jupytext`_ offers :doc:`other formats <jupytext:formats-markdown>`
based on plain text rather than JSON.

As a result, there are three modes of operation:
Expand All @@ -396,7 +396,7 @@ As a result, there are three modes of operation:
to improve the review process.
- Use a different collaboration workflow that doesn't involve notebooks.

- Replace ``.ipynb`` notebooks with :doc:`a text-based format <jupytext:formats>`.
- Replace ``.ipynb`` notebooks with :doc:`a text-based format <jupytext:formats-markdown>`.
These formats behave better under version control
and they can also be edited with normal text editors
that do not support cell-based JSON notebooks.
Expand All @@ -411,7 +411,7 @@ As a result, there are three modes of operation:
These approaches are not mutually exclusive,
nor you have to use a single format for all your notebooks.
For the examples in this document, we have used the :doc:`MyST Markdown
format <jupytext:formats>`.
format <jupytext:formats-markdown>`.

If you are using alternative formats for Jupyter notebooks,
you can include them in your Sphinx documentation
Expand Down