diff options
author | Jonathan Slenders <jonathan@slenders.be> | 2018-06-02 18:04:36 +0200 |
---|---|---|
committer | Jonathan Slenders <jonathan@slenders.be> | 2018-06-02 18:04:36 +0200 |
commit | b48e37c440fa86a95e097cf74e9095df7418f21e (patch) | |
tree | 3212612db3c0263d73feae23b9e543b26ec680d8 | |
parent | c0f864cf6ae5a9258192c64fcce3838bf9d294ae (diff) |
Added link to the upgrading page in the docs.
-rw-r--r-- | docs/index.rst | 10 | ||||
-rw-r--r-- | docs/pages/upgrading.rst | 8 |
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/index.rst b/docs/index.rst index 82dd891a..515ac0f0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,12 +3,10 @@ Python Prompt Toolkit 2.0 .. warning:: - Please notice that this is the documentation for the 2.0 branch of - prompt_toolkit. It is incompatible with the 1.0 branch, but much better in - many regards. On Pypi you'll still find the 1.0 branch, but a release - should follow soon. In the meantime, don't hesitate to test this branch and - report any bugs. - + Notice that this is the prompt_toolkit 2.0 documentation. It is + incompatible with the 1.0 branch, but much better in many regards. Please + read :ref:`Upgrading to prompt_toolkit 2.0 <upgrading_2_0>` for more + information. `prompt_toolkit` is a library for building powerful interactive command line and terminal applications in Python. diff --git a/docs/pages/upgrading.rst b/docs/pages/upgrading.rst index 24fb6b5f..5c0a558d 100644 --- a/docs/pages/upgrading.rst +++ b/docs/pages/upgrading.rst @@ -1,9 +1,11 @@ +.. _upgrading_2_0: + Upgrading to prompt_toolkit 2.0 =============================== -Prompt_toolkit 2.0 is not compatible with 1.0, however you want to upgrade your -applications. This page explains why we have these differences and how to -upgrade. +Prompt_toolkit 2.0 is not compatible with 1.0, however you probably want to +upgrade your applications. This page explains why we have these differences and +how to upgrade. If you experience some difficulties or you feel that some information is missing from this page, don't hesitate to open a GitHub issue for help. |