From 55d1356081c2d2226d7190dac2abdffbf8a0fb2f Mon Sep 17 00:00:00 2001 From: Christopher Wilcox Date: Fri, 6 Nov 2020 14:18:12 -0800 Subject: [PATCH] docs: add upgrading section to index of documentation (#248) * docs: adds UPGRADING.md, not to readme, to help inform users about migration to v2 * docs: erroneous version number * Update UPGRADING.md Co-authored-by: BenWhitehead * docs: clarify enums statement * docs: add migration section to docs index Co-authored-by: BenWhitehead --- docs/index.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 9354be97a..34002786f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,15 @@ API Reference types admin_client +Migration Guide +--------------- + +See the guide below for instructions on migrating to the 2.x release of this library. + +.. toctree:: + :maxdepth: 2 + + UPGRADING Changelog ---------