diff --git a/docs/source/howto.rst b/docs/source/howto.rst new file mode 100644 index 00000000..d95f33f1 --- /dev/null +++ b/docs/source/howto.rst @@ -0,0 +1,8 @@ +How To Guides +============= + +.. toctree:: + :maxdepth: 1 + + Handle Invalid Data + Migrate to v1 diff --git a/docs/source/pages/migrating-to-v1.rst b/docs/source/howto/migrate-to-v1.rst similarity index 99% rename from docs/source/pages/migrating-to-v1.rst rename to docs/source/howto/migrate-to-v1.rst index 527a810d..8833fbe0 100644 --- a/docs/source/pages/migrating-to-v1.rst +++ b/docs/source/howto/migrate-to-v1.rst @@ -1,5 +1,5 @@ -Migrating to v1.0 -================= +How To Migrate to v1.0 +====================== The most notable change of the ``v1.0`` release of ``pygls`` is the removal of its hand written LSP type and method definitions in favour of relying on the types provided by the `lsprotocol`_ library which are automatically generated from the LSP specification. As as side effect this has also meant the removal of `pydantic`_ as a dependency, since ``lsprotocol`` uses `attrs`_ and `cattrs`_ for serialisation and validation. diff --git a/docs/source/index.rst b/docs/source/index.rst index 430c9bf8..ac862d11 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -41,10 +41,15 @@ User Guide pages/tutorial pages/user-guide pages/testing - pages/migrating-to-v1 pages/reference +.. toctree:: + :hidden: + :caption: How To + + Migrate to v1 + .. _Language Server Protocol: https://microsoft.github.io/language-server-protocol/specification .. _Language server: https://langserver.org/ .. _pygls: https://github.com/openlawlibrary/pygls