From bc8e031bf9136856b9747ea230b7741f43b76662 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Mon, 14 Mar 2022 06:19:09 -0500 Subject: [PATCH 1/8] update links and fix check-release --- .github/workflows/check-release.yml | 1 + CHANGELOG.md | 2 +- CONTRIBUTING.rst | 4 ++-- README.md | 10 +++++----- docs-translations/hi-IN/README.md | 12 ++++++------ docs-translations/ja-JP/README.md | 10 +++++----- docs-translations/ko-KR/README.md | 10 +++++----- docs-translations/zh-CN/README.md | 12 ++++++------ docs/source/conf.py | 2 +- docs/source/config_overview.rst | 10 +++++----- docs/source/index.rst | 4 ++-- docs/source/notebook.rst | 2 +- notebook/static/notebook/js/notebook.js | 2 +- setup.py | 3 ++- 14 files changed, 43 insertions(+), 41 deletions(-) diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml index be28522243..14d6186a42 100644 --- a/.github/workflows/check-release.yml +++ b/.github/workflows/check-release.yml @@ -15,6 +15,7 @@ jobs: strategy: matrix: group: [check_release, link_check] + fail-fast: false steps: - name: Checkout uses: actions/checkout@v2 diff --git a/CHANGELOG.md b/CHANGELOG.md index cbe4d2dfe5..1f70f4cb66 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1349,7 +1349,7 @@ instructions. recursively, unlike normal config values, to make it load more consistently with frontend extensions([2108](https://github.com/jupyter/notebook/pull/2108)). - The notebook server now supports the [bundler - API](https://jupyter-notebook.readthedocs.io/en/latest/extending/bundler_extensions.html) + API](https://jupyter-notebook.readthedocs.io/en/stable/extending/bundler_extensions.html) from the [jupyter_cms incubator project](https://github.com/jupyter-incubator/contentmanagement) ([1579](https://github.com/jupyter/notebook/pull/1579)). - The notebook server now provides information about kernel activity diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6f947cb58c..4b7e1abda2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -14,7 +14,7 @@ General Guidelines For general documentation about contributing to Jupyter projects, see the `Project Jupyter Contributor Documentation`__. -__ https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html +__ https://jupyter.readthedocs.io/en/stable/contributing/content-contributor.html Setting Up a Development Environment @@ -194,4 +194,4 @@ Windows users can find ``make.bat`` in the ``docs`` folder. You should also have a look at the `Project Jupyter Documentation Guide`__. -__ https://jupyter.readthedocs.io/en/latest/contributing/docs-contributions/index.html +__ https://jupyter.readthedocs.io/en/stable/contributing/docs-contributions/index.html diff --git a/README.md b/README.md index 8f6c2c7491..819cc877b2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter) [![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook) -[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/stable/?badge=latest) [![codecov](https://codecov.io/gh/jupyter/notebook/branch/master/graph/badge.svg)](https://codecov.io/gh/jupyter/notebook) The Jupyter notebook is a web-based notebook environment for interactive @@ -37,9 +37,9 @@ discrete repos. ## Installation You can find the installation documentation for the -[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html). +[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/stable/install.html). The documentation for advanced usage of Jupyter notebook can be found -[here](https://jupyter-notebook.readthedocs.io/en/latest/). +[here](https://jupyter-notebook.readthedocs.io/en/stable/). For a local installation, make sure you have [pip installed](https://pip.readthedocs.io/en/stable/installing/) and run: @@ -69,8 +69,8 @@ If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](C ## Resources - [Project Jupyter website](https://jupyter.org) - [Online Demo at jupyter.org/try](https://jupyter.org/try) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/hi-IN/README.md b/docs-translations/hi-IN/README.md index e234e3dac7..01f43bdf64 100644 --- a/docs-translations/hi-IN/README.md +++ b/docs-translations/hi-IN/README.md @@ -2,7 +2,7 @@ [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter) [![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook) -[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/stable/?badge=latest) @@ -38,9 +38,9 @@ IPython कोडबेस का बिग स्प्लिट ™। IPython ## स्थापना आप के लिए स्थापना प्रलेखन पा सकते हैं -[बृहस्पति मंच, ReadTheDocs पर](https://jupyter.readthedocs.io/en/latest/install.html). +[बृहस्पति मंच, ReadTheDocs पर](https://jupyter.readthedocs.io/en/stable/install.html). जुपिटर नोटबुक के उन्नत उपयोग के लिए दस्तावेज पाया जा सकता है -[यहाँ](https://jupyter-notebook.readthedocs.io/en/latest/). +[यहाँ](https://jupyter-notebook.readthedocs.io/en/stable/). स्थानीय स्थापना के लिए, सुनिश्चित करें कि आपके पास है [pip स्थापित](https://pip.readthedocs.io/en/stable/installing/) और भाग खड़ा हुआ: @@ -70,8 +70,8 @@ IPython कोडबेस का बिग स्प्लिट ™। IPython ## साधन - [Project Jupyter website](https://jupyter.org) - [Online Demo at jupyter.org/try](https://jupyter.org/try) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] - [Issues](https://github.com/jupyter/notebook/issues) -- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) \ No newline at end of file +- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/ja-JP/README.md b/docs-translations/ja-JP/README.md index 4a344ce26e..2a677e9fea 100644 --- a/docs-translations/ja-JP/README.md +++ b/docs-translations/ja-JP/README.md @@ -2,7 +2,7 @@ [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter) [![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook) -[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/stable/?badge=latest) 英語版のリンク : [[English Version](http://github.com/jupyter/notebook/)] @@ -20,8 +20,8 @@ Jupyter Notebookは、Project Jupyter用の言語に依存しないHTMLノート ## インストール -[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html)から、インストールドキュメントをご覧になれます。 -Jupyter Notebookの発展的な使用方法に関するドキュメントは、[こちら](https://jupyter-notebook.readthedocs.io/en/latest/)をご覧ください。 +[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/stable/install.html)から、インストールドキュメントをご覧になれます。 +Jupyter Notebookの発展的な使用方法に関するドキュメントは、[こちら](https://jupyter-notebook.readthedocs.io/en/stable/)をご覧ください。 ローカルへのインストールの場合、[pip](https://pip.readthedocs.io/en/stable/installing/)をインストールしていることを確認し、以下のコマンドを実行してください。 @@ -51,7 +51,7 @@ Jupyter Notebookをリモートで起動する前に、いくつかの構成が - [Project Jupyter website](https://jupyter.org) - [Online Demo at try.jupyter.org](https://try.jupyter.org) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)] -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/ko-KR/README.md b/docs-translations/ko-KR/README.md index 4fad2a8dac..a3e63fb37b 100644 --- a/docs-translations/ko-KR/README.md +++ b/docs-translations/ko-KR/README.md @@ -2,7 +2,7 @@ [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter) [![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook) -[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](http://jupyter-notebook.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](http://jupyter-notebook.readthedocs.io/en/stable/?badge=stable) English 버전 링크 : [[English Version](http://github.com/jupyter/notebook/)] @@ -21,9 +21,9 @@ IPython 3는 *IPython notebook* 과 같은 사용자 언어에 독립적인 코 ## 설치 설치법 문서는 다음 주소에서 찾을 수 있습니다. You can find the installation documentation for the -[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html). +[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/stable/install.html). 조금 더 심화된 Jupyter notebook의 사용은 다음 주소에서 볼 수 있습니다. -[here](https://jupyter-notebook.readthedocs.io/en/latest/). +[here](https://jupyter-notebook.readthedocs.io/en/stable/). 설치를 위해서는 [pip installed](https://pip.readthedocs.io/en/stable/installing/) 가 있는지 확인한 후 다음을 실행해주세요: @@ -49,7 +49,7 @@ You can find the installation documentation for the ## 자료 - [Project Jupyter website](https://jupyter.org) - [Online Demo at try.jupyter.org](https://try.jupyter.org) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)] -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/zh-CN/README.md b/docs-translations/zh-CN/README.md index 13da7f722b..05b44824ab 100644 --- a/docs-translations/zh-CN/README.md +++ b/docs-translations/zh-CN/README.md @@ -2,7 +2,7 @@ [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter) [![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook) -[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/stable/?badge=latest) @@ -38,9 +38,9 @@ IPython代码库的Big Split™。 IPython 3是最后一个主要的整体 ## 成立 您可以找到以下安装文件 -[Jupiter论坛，在ReadTheDocs上](https://jupyter.readthedocs.io/en/latest/install.html). +[Jupiter论坛，在ReadTheDocs上](https://jupyter.readthedocs.io/en/stable/install.html). 可以找到有关Jupiter笔记本的高级使用的文档 -[这里](https://jupyter-notebook.readthedocs.io/en/latest/). +[这里](https://jupyter-notebook.readthedocs.io/en/stable/). 对于本地安装，请确保您已经 [pip 成立时间](https://pip.readthedocs.io/en/stable/installing/) 并运行： @@ -70,8 +70,8 @@ IPython代码库的Big Split™。 IPython 3是最后一个主要的整体 ## 资源 - [Project Jupyter website](https://jupyter.org) - [Online Demo at jupyter.org/try](https://jupyter.org/try) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] - [Issues](https://github.com/jupyter/notebook/issues) -- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) \ No newline at end of file +- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs/source/conf.py b/docs/source/conf.py index 1aa7613b42..c608abc4d3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -350,7 +350,7 @@ 'ipython': ('https://ipython.readthedocs.io/en/stable/', None), 'nbconvert': ('https://nbconvert.readthedocs.io/en/latest/', None), 'nbformat': ('https://nbformat.readthedocs.io/en/latest/', None), - 'jupyter': ('https://jupyter.readthedocs.io/en/latest/', None), + 'jupyter': ('https://jupyter.readthedocs.io/en/stable/', None), } spelling_lang='en_US' diff --git a/docs/source/config_overview.rst b/docs/source/config_overview.rst index ccb64a2751..13992dd22c 100644 --- a/docs/source/config_overview.rst +++ b/docs/source/config_overview.rst @@ -22,9 +22,9 @@ Jupyter applications, from the Notebook to JupyterHub to nbgrader, share a common configuration system. The process for creating a configuration file and editing settings is similar for all the Jupyter applications. - - `Jupyter’s Common Configuration Approach `_ - - `Common Directories and File Locations `_ - - `Language kernels `_ + - `Jupyter’s Common Configuration Approach `_ + - `Common Directories and File Locations `_ + - `Language kernels `_ - `traitlets `_ provide a low-level architecture for configuration. @@ -64,8 +64,8 @@ Notebook front-end client Notebook extensions ------------------- -- `Distributing Jupyter Extensions as Python Packages `_ -- `Extending the Notebook `_ +- `Distributing Jupyter Extensions as Python Packages `_ +- `Extending the Notebook `_ :ref:`Security in Jupyter notebooks: ` Since security diff --git a/docs/source/index.rst b/docs/source/index.rst index 71e2ca132e..fbce064d28 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,8 +2,8 @@ The Jupyter Notebook ==================== -* `Installation `_ -* `Starting the Notebook `_ +* `Installation `_ +* `Starting the Notebook `_ .. toctree:: :maxdepth: 1 diff --git a/docs/source/notebook.rst b/docs/source/notebook.rst index fb1e0195c5..a98eebb5cf 100644 --- a/docs/source/notebook.rst +++ b/docs/source/notebook.rst @@ -89,7 +89,7 @@ Notebooks and privacy Because you use Jupyter in a web browser, some people are understandably concerned about using it with sensitive data. However, if you followed the standard -`install instructions `_, +`install instructions `_, Jupyter is actually running on your own computer. If the URL in the address bar starts with ``http://localhost:`` or ``http://127.0.0.1:``, it's your computer acting as the server. diff --git a/notebook/static/notebook/js/notebook.js b/notebook/static/notebook/js/notebook.js index 606851b965..967362ab51 100644 --- a/notebook/static/notebook/js/notebook.js +++ b/notebook/static/notebook/js/notebook.js @@ -2992,7 +2992,7 @@ define([ .text(i18n.msg._("A trusted Jupyter notebook may execute hidden malicious code when you open it. " + "Selecting trust will immediately reload this notebook in a trusted state. " + "For more information, see the Jupyter security documentation: ")) - .append($("").attr("href", "https://jupyter-notebook.readthedocs.io/en/latest/security.html") + .append($("").attr("href", "https://jupyter-notebook.readthedocs.io/en/stable/security.html") .text(i18n.msg._("here")) ) ); diff --git a/setup.py b/setup.py index 8129e42f08..09d1bceca1 100755 --- a/setup.py +++ b/setup.py @@ -85,6 +85,7 @@ Read `the documentation `_ for more information. """, + long_description_content_type = ' text/markdown', version = version, packages = find_packages(), package_data = find_package_data(), @@ -93,7 +94,7 @@ author_email = 'jupyter@googlegroups.com', url = 'http://jupyter.org', license = 'BSD', - platforms = "Linux, Mac OS X, Windows", + platforms = "Linux, Mac OS X, Windows",, keywords = ['Interactive', 'Interpreter', 'Shell', 'Web'], classifiers = [ 'Intended Audience :: Developers', From 1567b734ce0e339d578270e472a8ceb0d94930d0 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Mon, 14 Mar 2022 06:20:11 -0500 Subject: [PATCH 2/8] fix syntax --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 09d1bceca1..fb3d36553c 100755 --- a/setup.py +++ b/setup.py @@ -94,7 +94,7 @@ author_email = 'jupyter@googlegroups.com', url = 'http://jupyter.org', license = 'BSD', - platforms = "Linux, Mac OS X, Windows",, + platforms = "Linux, Mac OS X, Windows", keywords = ['Interactive', 'Interpreter', 'Shell', 'Web'], classifiers = [ 'Intended Audience :: Developers', From a8d1919e8e514a25f6c8c1284c609eb339822ac4 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Mon, 14 Mar 2022 06:24:07 -0500 Subject: [PATCH 3/8] add missing dep --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index fb3d36553c..bb142776f7 100755 --- a/setup.py +++ b/setup.py @@ -120,6 +120,7 @@ 'traitlets>=4.2.1', 'jupyter_core>=4.6.1', 'jupyter_client>=5.3.4', + 'ipython_genutils', 'nbformat', 'nbconvert>=5', 'nest-asyncio>=1.5', From 87b859f38218592667978163fd769d9a23ea7cce Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Mon, 14 Mar 2022 06:38:41 -0500 Subject: [PATCH 4/8] remove dead links --- README.md | 4 ++-- docs-translations/hi-IN/README.md | 4 ++-- docs-translations/ja-JP/README.md | 4 ++-- docs-translations/ko-KR/README.md | 4 ++-- docs-translations/zh-CN/README.md | 4 ++-- docs/doc-requirements.txt | 1 + 6 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 819cc877b2..b34b058a59 100644 --- a/README.md +++ b/README.md @@ -69,8 +69,8 @@ If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](C ## Resources - [Project Jupyter website](https://jupyter.org) - [Online Demo at jupyter.org/try](https://jupyter.org/try) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/hi-IN/README.md b/docs-translations/hi-IN/README.md index 01f43bdf64..0260cb9754 100644 --- a/docs-translations/hi-IN/README.md +++ b/docs-translations/hi-IN/README.md @@ -70,8 +70,8 @@ IPython कोडबेस का बिग स्प्लिट ™। IPython ## साधन - [Project Jupyter website](https://jupyter.org) - [Online Demo at jupyter.org/try](https://jupyter.org/try) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/ja-JP/README.md b/docs-translations/ja-JP/README.md index 2a677e9fea..3cc6800211 100644 --- a/docs-translations/ja-JP/README.md +++ b/docs-translations/ja-JP/README.md @@ -51,7 +51,7 @@ Jupyter Notebookをリモートで起動する前に、いくつかの構成が - [Project Jupyter website](https://jupyter.org) - [Online Demo at try.jupyter.org](https://try.jupyter.org) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/ko-KR/README.md b/docs-translations/ko-KR/README.md index a3e63fb37b..22e916bc02 100644 --- a/docs-translations/ko-KR/README.md +++ b/docs-translations/ko-KR/README.md @@ -49,7 +49,7 @@ You can find the installation documentation for the ## 자료 - [Project Jupyter website](https://jupyter.org) - [Online Demo at try.jupyter.org](https://try.jupyter.org) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/zh-CN/README.md b/docs-translations/zh-CN/README.md index 05b44824ab..ca4276241a 100644 --- a/docs-translations/zh-CN/README.md +++ b/docs-translations/zh-CN/README.md @@ -70,8 +70,8 @@ IPython代码库的Big Split™。 IPython 3是最后一个主要的整体 ## 资源 - [Project Jupyter website](https://jupyter.org) - [Online Demo at jupyter.org/try](https://jupyter.org/try) -- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/stable/jupyter-notebook.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/stable/jupyter.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt index bb439ddcf2..3b6551624c 100644 --- a/docs/doc-requirements.txt +++ b/docs/doc-requirements.txt @@ -3,3 +3,4 @@ sphinx-rtd-theme nbsphinx sphinxcontrib_github_alt myst_parser +ipython_genutils From 7643c0e05185854cd62cfcba84e960e07f40d69e Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Mon, 14 Mar 2022 06:51:38 -0500 Subject: [PATCH 5/8] fix rtd --- README.md | 2 +- docs-translations/hi-IN/README.md | 2 +- docs-translations/ja-JP/README.md | 2 +- docs-translations/ko-KR/README.md | 2 +- docs-translations/zh-CN/README.md | 2 +- docs/environment.yml | 1 + setup.py | 1 - 7 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b34b058a59..c2cd5bfca5 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,6 @@ If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](C - [Online Demo at jupyter.org/try](https://jupyter.org/try) - [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html ) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/hi-IN/README.md b/docs-translations/hi-IN/README.md index 0260cb9754..b7d000697e 100644 --- a/docs-translations/hi-IN/README.md +++ b/docs-translations/hi-IN/README.md @@ -72,6 +72,6 @@ IPython कोडबेस का बिग स्प्लिट ™। IPython - [Online Demo at jupyter.org/try](https://jupyter.org/try) - [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html ) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/ja-JP/README.md b/docs-translations/ja-JP/README.md index 3cc6800211..7e3ab58ce3 100644 --- a/docs-translations/ja-JP/README.md +++ b/docs-translations/ja-JP/README.md @@ -52,6 +52,6 @@ Jupyter Notebookをリモートで起動する前に、いくつかの構成が - [Project Jupyter website](https://jupyter.org) - [Online Demo at try.jupyter.org](https://try.jupyter.org) - [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html ) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/ko-KR/README.md b/docs-translations/ko-KR/README.md index 22e916bc02..c375a96469 100644 --- a/docs-translations/ko-KR/README.md +++ b/docs-translations/ko-KR/README.md @@ -50,6 +50,6 @@ You can find the installation documentation for the - [Project Jupyter website](https://jupyter.org) - [Online Demo at try.jupyter.org](https://try.jupyter.org) - [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html ) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs-translations/zh-CN/README.md b/docs-translations/zh-CN/README.md index ca4276241a..311954161d 100644 --- a/docs-translations/zh-CN/README.md +++ b/docs-translations/zh-CN/README.md @@ -72,6 +72,6 @@ IPython代码库的Big Split™。 IPython 3是最后一个主要的整体 - [Online Demo at jupyter.org/try](https://jupyter.org/try) - [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/stable/) - [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/) -- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/stable/index.html) +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html ) - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs/environment.yml b/docs/environment.yml index 52ef4df581..55cea9b26c 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -18,3 +18,4 @@ dependencies: - Send2Trash - prometheus_client - sphinxcontrib_github_alt + - ipython_genutils diff --git a/setup.py b/setup.py index bb142776f7..2f83bb017a 100755 --- a/setup.py +++ b/setup.py @@ -116,7 +116,6 @@ # but hopefully avoids incompatibilities with Tornado 5. April 2018 'pyzmq>=17', 'argon2-cffi', - 'ipython_genutils', 'traitlets>=4.2.1', 'jupyter_core>=4.6.1', 'jupyter_client>=5.3.4', From ffbd1d3aef7b96a1d4cc55e47ee3c24fc20db64c Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Mon, 14 Mar 2022 07:11:30 -0500 Subject: [PATCH 6/8] fix some links --- CONTRIBUTING.rst | 4 ++-- README.md | 2 +- docs-translations/hi-IN/README.md | 2 +- docs-translations/ja-JP/README.md | 2 +- docs-translations/ko-KR/README.md | 2 +- docs-translations/zh-CN/README.md | 2 +- docs/source/conf.py | 2 +- docs/source/config_overview.rst | 6 +++--- docs/source/index.rst | 4 ++-- docs/source/notebook.rst | 2 +- 10 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4b7e1abda2..6f947cb58c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -14,7 +14,7 @@ General Guidelines For general documentation about contributing to Jupyter projects, see the `Project Jupyter Contributor Documentation`__. -__ https://jupyter.readthedocs.io/en/stable/contributing/content-contributor.html +__ https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html Setting Up a Development Environment @@ -194,4 +194,4 @@ Windows users can find ``make.bat`` in the ``docs`` folder. You should also have a look at the `Project Jupyter Documentation Guide`__. -__ https://jupyter.readthedocs.io/en/stable/contributing/docs-contributions/index.html +__ https://jupyter.readthedocs.io/en/latest/contributing/docs-contributions/index.html diff --git a/README.md b/README.md index c2cd5bfca5..a69283458d 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ discrete repos. ## Installation You can find the installation documentation for the -[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/stable/install.html). +[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html). The documentation for advanced usage of Jupyter notebook can be found [here](https://jupyter-notebook.readthedocs.io/en/stable/). diff --git a/docs-translations/hi-IN/README.md b/docs-translations/hi-IN/README.md index b7d000697e..1e85490e66 100644 --- a/docs-translations/hi-IN/README.md +++ b/docs-translations/hi-IN/README.md @@ -38,7 +38,7 @@ IPython कोडबेस का बिग स्प्लिट ™। IPython ## स्थापना आप के लिए स्थापना प्रलेखन पा सकते हैं -[बृहस्पति मंच, ReadTheDocs पर](https://jupyter.readthedocs.io/en/stable/install.html). +[बृहस्पति मंच, ReadTheDocs पर](https://jupyter.readthedocs.io/en/latest/install.html). जुपिटर नोटबुक के उन्नत उपयोग के लिए दस्तावेज पाया जा सकता है [यहाँ](https://jupyter-notebook.readthedocs.io/en/stable/). diff --git a/docs-translations/ja-JP/README.md b/docs-translations/ja-JP/README.md index 7e3ab58ce3..9262cdbecc 100644 --- a/docs-translations/ja-JP/README.md +++ b/docs-translations/ja-JP/README.md @@ -20,7 +20,7 @@ Jupyter Notebookは、Project Jupyter用の言語に依存しないHTMLノート ## インストール -[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/stable/install.html)から、インストールドキュメントをご覧になれます。 +[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html)から、インストールドキュメントをご覧になれます。 Jupyter Notebookの発展的な使用方法に関するドキュメントは、[こちら](https://jupyter-notebook.readthedocs.io/en/stable/)をご覧ください。 ローカルへのインストールの場合、[pip](https://pip.readthedocs.io/en/stable/installing/)をインストールしていることを確認し、以下のコマンドを実行してください。 diff --git a/docs-translations/ko-KR/README.md b/docs-translations/ko-KR/README.md index c375a96469..a54b996648 100644 --- a/docs-translations/ko-KR/README.md +++ b/docs-translations/ko-KR/README.md @@ -21,7 +21,7 @@ IPython 3는 *IPython notebook* 과 같은 사용자 언어에 독립적인 코 ## 설치 설치법 문서는 다음 주소에서 찾을 수 있습니다. You can find the installation documentation for the -[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/stable/install.html). +[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html). 조금 더 심화된 Jupyter notebook의 사용은 다음 주소에서 볼 수 있습니다. [here](https://jupyter-notebook.readthedocs.io/en/stable/). diff --git a/docs-translations/zh-CN/README.md b/docs-translations/zh-CN/README.md index 311954161d..5bee3f7d4c 100644 --- a/docs-translations/zh-CN/README.md +++ b/docs-translations/zh-CN/README.md @@ -38,7 +38,7 @@ IPython代码库的Big Split™。 IPython 3是最后一个主要的整体 ## 成立 您可以找到以下安装文件 -[Jupiter论坛，在ReadTheDocs上](https://jupyter.readthedocs.io/en/stable/install.html). +[Jupiter论坛，在ReadTheDocs上](https://jupyter.readthedocs.io/en/latest/install.html). 可以找到有关Jupiter笔记本的高级使用的文档 [这里](https://jupyter-notebook.readthedocs.io/en/stable/). diff --git a/docs/source/conf.py b/docs/source/conf.py index c608abc4d3..1aa7613b42 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -350,7 +350,7 @@ 'ipython': ('https://ipython.readthedocs.io/en/stable/', None), 'nbconvert': ('https://nbconvert.readthedocs.io/en/latest/', None), 'nbformat': ('https://nbformat.readthedocs.io/en/latest/', None), - 'jupyter': ('https://jupyter.readthedocs.io/en/stable/', None), + 'jupyter': ('https://jupyter.readthedocs.io/en/latest/', None), } spelling_lang='en_US' diff --git a/docs/source/config_overview.rst b/docs/source/config_overview.rst index 13992dd22c..96356d07aa 100644 --- a/docs/source/config_overview.rst +++ b/docs/source/config_overview.rst @@ -22,9 +22,9 @@ Jupyter applications, from the Notebook to JupyterHub to nbgrader, share a common configuration system. The process for creating a configuration file and editing settings is similar for all the Jupyter applications. - - `Jupyter’s Common Configuration Approach `_ - - `Common Directories and File Locations `_ - - `Language kernels `_ + - `Jupyter’s Common Configuration Approach `_ + - `Common Directories and File Locations `_ + - `Language kernels `_ - `traitlets `_ provide a low-level architecture for configuration. diff --git a/docs/source/index.rst b/docs/source/index.rst index fbce064d28..71e2ca132e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,8 +2,8 @@ The Jupyter Notebook ==================== -* `Installation `_ -* `Starting the Notebook `_ +* `Installation `_ +* `Starting the Notebook `_ .. toctree:: :maxdepth: 1 diff --git a/docs/source/notebook.rst b/docs/source/notebook.rst index a98eebb5cf..fb1e0195c5 100644 --- a/docs/source/notebook.rst +++ b/docs/source/notebook.rst @@ -89,7 +89,7 @@ Notebooks and privacy Because you use Jupyter in a web browser, some people are understandably concerned about using it with sensitive data. However, if you followed the standard -`install instructions `_, +`install instructions `_, Jupyter is actually running on your own computer. If the URL in the address bar starts with ``http://localhost:`` or ``http://127.0.0.1:``, it's your computer acting as the server. From 4cd3f78b88c072595ab9322ecbe451457dee8751 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Mon, 14 Mar 2022 07:22:11 -0500 Subject: [PATCH 7/8] fix another link --- docs/source/notebook.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/notebook.rst b/docs/source/notebook.rst index fb1e0195c5..f5db5f95b2 100644 --- a/docs/source/notebook.rst +++ b/docs/source/notebook.rst @@ -234,7 +234,7 @@ drop-down on the toolbar (which will be "Code", initially), or via For more information on the different things you can do in a notebook, see the `collection of examples -`_. +`_. Code cells ~~~~~~~~~~ From e5295bedccd973ccebb9e44d1df06f218a01e59e Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Mon, 14 Mar 2022 07:34:09 -0500 Subject: [PATCH 8/8] update more links --- docs/source/examples/Notebook/examples_index.rst | 2 +- docs/source/links.txt | 4 ++-- docs/source/template.tpl | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/examples/Notebook/examples_index.rst b/docs/source/examples/Notebook/examples_index.rst index 61bddadd07..9339074573 100644 --- a/docs/source/examples/Notebook/examples_index.rst +++ b/docs/source/examples/Notebook/examples_index.rst @@ -5,7 +5,7 @@ Notebook Examples The pages in this section are all converted notebook files. You can also `view these notebooks on nbviewer`__. -__ https://nbviewer.jupyter.org/github/jupyter/notebook/blob/master/ +__ https://nbviewer.jupyter.org/github/jupyter/notebook/blob/6.4.x/ docs/source/examples/Notebook/ .. toctree:: diff --git a/docs/source/links.txt b/docs/source/links.txt index 0306b047fb..f6503b7544 100644 --- a/docs/source/links.txt +++ b/docs/source/links.txt @@ -19,7 +19,7 @@ .. Main Jupyter notebook links .. _Notebook Basics: notebook_p2_ -.. _notebook_p2: https://nbviewer.jupyter.org/github/jupyter/notebook/blob/master/docs/source/examples/Notebook/Notebook%20Basics.ipynb +.. _notebook_p2: https://nbviewer.jupyter.org/github/jupyter/notebook/blob/6.4.x/docs/source/examples/Notebook/Notebook%20Basics.ipynb .. _Running Code in the Jupyter Notebook: notebook_p1_ .. _notebook_p1: https://nbviewer.jupyter.org/github/jupyter/notebook/blob/master/docs/source/examples/Notebook/Running%20Code.ipynb @@ -38,4 +38,4 @@ .. _Plotting with Matplotlib: notebook_p3_ .. _notebook_p3: https://nbviewer.jupyter.org/github/ipython/ipython/blob/master/examples/IPython%20Kernel/Plotting%20in%20the%20Notebook.ipynb -.. _Working with Markdown Cells: https://nbviewer.jupyter.org/github/jupyter/notebook/blob/master/docs/source/examples/Notebook/Working%20With%20Markdown%20Cells.ipynb +.. _Working with Markdown Cells: https://nbviewer.jupyter.org/github/jupyter/notebook/blob/6.4.x/docs/source/examples/Notebook/Working%20With%20Markdown%20Cells.ipynb diff --git a/docs/source/template.tpl b/docs/source/template.tpl index 411ef7c68d..8c9d4af9e9 100644 --- a/docs/source/template.tpl +++ b/docs/source/template.tpl @@ -2,7 +2,7 @@ {% macro notebooklink() -%} -`View the original notebook on nbviewer `__ +`View the original notebook on nbviewer `__ {%- endmacro %}