From e1a22aae9008d89af97323a2cf200adfa3ee4589 Mon Sep 17 00:00:00 2001 From: JBGreisman Date: Tue, 21 Feb 2023 09:06:01 -0500 Subject: [PATCH] Upgrade sphinx version by removing sphinx_panels dependency --- docs/conf.py | 3 ++- docs/index.rst | 58 +++++++++++++++++++++++++++++--------------------- setup.py | 3 +-- 3 files changed, 37 insertions(+), 27 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index c41dac72..ccde52f8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,7 +40,7 @@ "sphinx_rtd_theme", "nbsphinx", "sphinx.ext.linkcode", - "sphinx_panels", + "sphinx_design", "sphinxcontrib.autoprogram", "autodocsumm", ] @@ -146,6 +146,7 @@ def setup(app): # -- Resolve links to source code -------------------------------------------- + # based on pandas/doc/source/conf.py def linkcode_resolve(domain, info): """ diff --git a/docs/index.rst b/docs/index.rst index 87a7faf8..cae41521 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,30 +19,40 @@ Features of this library include: symmetry operations. - Support for reading and writing MTZ reflection files. -.. panels:: - :container: container-lg pb-3 - :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 - - The user guide provides information about installing and using ``reciprocalspaceship`` - +++ - .. link-button:: userguide/index - :type: ref - :text: User Guide - :classes: btn-outline-primary btn-block stretched-link - --- - The API reference provides detailed information about the Python API for the library - +++ - .. link-button:: api/index - :type: ref - :text: API Reference - :classes: btn-outline-primary btn-block stretched-link - --- - The developer's guide is a resource for those looking to contribute to this project - +++ - .. link-button:: developers/index - :type: ref - :text: Developer Guide - :classes: btn-outline-primary btn-block stretched-link +.. grid:: 3 + + .. grid-item-card:: User Guide + + The user guide provides information about installing and using ``reciprocalspaceship`` + + .. button-ref:: userguide/index + :color: primary + :shadow: + :expand: + + User Guide + + .. grid-item-card:: API Reference + + The API reference provides details about the Python API for the library + + .. button-ref:: api/index + :color: primary + :shadow: + :expand: + + API Reference + + .. grid-item-card:: Developer's Guide + + The developer's guide is a resource for those looking to contribute to this project + + .. button-ref:: developers/index + :color: primary + :shadow: + :expand: + + Developer's Guide .. toctree:: :maxdepth: 1 diff --git a/setup.py b/setup.py index 42c1ed9f..3da0e50c 100644 --- a/setup.py +++ b/setup.py @@ -45,8 +45,7 @@ def getVersionNumber(): "sphinx", "sphinx_rtd_theme", "nbsphinx", - "jinja2<3.1.0", - "sphinx-panels", + "sphinx-design", "sphinxcontrib-autoprogram", "autodocsumm", ]