From 4f8475e1218ac317b00c27d6a329237da68d16bf Mon Sep 17 00:00:00 2001 From: Niclas Rieger Date: Wed, 4 Sep 2024 22:39:42 +0200 Subject: [PATCH] docs: fix path to index.rst --- docs/conf.py | 2 +- docs/{content => }/index.rst | 24 ++++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) rename docs/{content => }/index.rst (75%) diff --git a/docs/conf.py b/docs/conf.py index 0222968..f5e3dc0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ source_suffix = ".rst" # The master toctree document. -master_doc = "content/index" +master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/content/index.rst b/docs/index.rst similarity index 75% rename from docs/content/index.rst rename to docs/index.rst index a5f4c1a..aae8989 100644 --- a/docs/content/index.rst +++ b/docs/index.rst @@ -1,12 +1,12 @@ -.. image:: ../logos/xeofs_logo_dark.png +.. image:: logos/xeofs_logo_dark.png :class: only-dark :align: center :width: 1000 :alt: logo of xeofs -.. image:: ../logos/xeofs_logo_light.png +.. image:: logos/xeofs_logo_light.png :class: only-light :align: center :width: 1000 @@ -24,11 +24,11 @@ Extracting Patterns from Climate Data :maxdepth: 3 :hidden: - user_guide/index - user_guide/installation - api_reference/index - whats_new/CHANGELOG - contributing + content/user_guide/index + content/user_guide/installation + content/api_reference/index + content/whats_new/CHANGELOG + content/contributing @@ -38,7 +38,7 @@ xeofs is a specialized Python package designed for dimensionality reduction in c .. grid-item-card:: :octicon:`repo;10em` - :link: user_guide/index + :link: content/user_guide/index :link-type: doc :text-align: center @@ -48,7 +48,7 @@ xeofs is a specialized Python package designed for dimensionality reduction in c .. grid-item-card:: :octicon:`gear;10em` - :link: user_guide/installation + :link: content/user_guide/installation :link-type: doc :text-align: center @@ -61,7 +61,7 @@ xeofs is a specialized Python package designed for dimensionality reduction in c .. grid-item-card:: :octicon:`search;10em` - :link: api_reference/index + :link: content/api_reference/index :link-type: doc :text-align: center @@ -71,7 +71,7 @@ xeofs is a specialized Python package designed for dimensionality reduction in c .. grid-item-card:: :octicon:`people;10em` - :link: contributing + :link: content/contributing :link-type: doc :text-align: center @@ -87,7 +87,7 @@ xeofs is a specialized Python package designed for dimensionality reduction in c .. note:: - Version 3 has been released! Check out the :doc:`CHANGELOG` for more details. For users of previous versions, see the :doc:`migration guide`. + Version 3 has been released! Check out the :doc:`CHANGELOG` for more details. For users of previous versions, see the :doc:`migration guide`. .. _xarray: https://docs.xarray.dev/en/stable/index.html .. _Dask: https://dask.org/