docs: change directory structure, rename contributing guide

README.md

@@ -12,10 +12,12 @@ A library that provides a set of tools and utilities to handle, manipulate, and
 visualize data from condensed matter physics experiments, with a focus on
 angle-resolved photoemission spectroscopy (ARPES).
 
-*ERLabPy* is built on top of the popular scientific computing libraries `numpy`,
-`scipy`, and `xarray`, and is designed to be easy to use and integrate with
-existing scientific Python workflows. It is also designed to be extensible,
-allowing users to easily add custom functionality and analysis tools.
+*ERLabPy* is built on top of the popular scientific computing libraries
+[*numpy*](https://numpy.org/), [*scipy*](https://scipy.org/), and
+[*xarray*](https://xarray.pydata.org/), and is designed to be easy to use and
+integrate with existing scientific Python workflows. It is also designed to be
+extensible, allowing users to easily add custom functionality and analysis
+tools.
 
 *ERLabPy* is developed and maintained by the electronic structure research
 laboratory at Korea Advanced Institute of Science and Technology (KAIST).
@@ -72,7 +74,7 @@ issue [here](https://github.com/kmnhan/erlabpy/issues). If you would like to add
 a new feature or fix a bug yourself, we would love to have your contribution.
 Feel free to fork the repository and submit a pull request with your changes.
 
-For more information on contributing, see the [development guide](https://erlabpy.readthedocs.io/en/stable/development.html).
+For more information on contributing, see our [Contributing page](https://erlabpy.readthedocs.io/en/stable/contributing.html).
 
 ## License
 

docs/source/development.rst → docs/source/contributing.rst

@@ -1,6 +1,6 @@
-*****************
-Development Guide
-*****************
+******************
+Contributing Guide
+******************
 
 .. note::
 
@@ -9,6 +9,7 @@ Development Guide
   `Contributing to xarray
   <https://docs.xarray.dev/en/stable/contributing.html>`_.
 
+All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.
 
 Creating a development environment
 ==================================

docs/source/getting-started.rst

@@ -34,13 +34,15 @@ If you don’t use conda, you can install ERLabPy with pip: ::
 
   pip install erlab
 
+If you wish to install ERLabPy from source, see the :doc:`contributing`.
+
 Dependencies
 ============
 
 ERLabPy is installed with many different python libraries. Some key packages and
 links to their documentation are listed below as a reference. In particular,
 this documentation assumes basic familiarity with the first four packages, which
-are sufficient for most use cases.
+will be sufficient for most use cases.
 
 .. list-table::
     :header-rows: 1
@@ -65,9 +67,11 @@ are sufficient for most use cases.
 ERLabPy also requires a Qt library such as PyQt5, PyQt6, PySide2, or PySide6. To
 ensure compatibility and keep the namespace clean, ERLabPy imports Qt bindings
 from `qtpy <https://github.com/spyder-ide/qtpy>`_, which will automatically
-select the appropriate library based on what is installed.
+select the appropriate library based on what is installed. Be aware that there
+are some known compatibility issues with PyQt5 and PySide2, so it is recommended
+to use the newer PyQt6 or PySide6 if possible.
 
-See the :doc:`userguide` to start using ERLabPy!
+See the :doc:`user-guide/index` to start using ERLabPy!
 
 
 Optional dependencies
@@ -95,7 +99,7 @@ listed just for convenience.
       - More colormaps!
 
 For a full list of dependencies and optional dependencies, take a look at the ``[project]`` and ``[project.optional-dependencies]`` section in
-``pyproject.toml``:
+`pyproject.toml <https://github.com/kmnhan/erlabpy/blob/main/pyproject.toml>`_:
 
 .. literalinclude:: ../../pyproject.toml
    :language: toml

docs/source/index.rst

@@ -43,7 +43,7 @@ angle-resolved photoemission spectroscopy (ARPES).
          overview on the dependencies.
 
     .. grid-item-card::  User guide
-        :link: userguide
+        :link: user-guide/index
         :link-type: doc
 
          The user guide provides some tutorials and examples on how to use
@@ -56,11 +56,11 @@ angle-resolved photoemission spectroscopy (ARPES).
          The reference guide provides detailed information of the API, including
          descriptions of most available methods and parameters.
 
-    .. grid-item-card::  Development guide
-        :link: development
+    .. grid-item-card::  Contributing guide
+        :link: contributing
         :link-type: doc
 
-         The development guide contains information on how to contribute to the
+         The contributing guide contains information on how to contribute to the
          project.
 
 
@@ -80,7 +80,7 @@ angle-resolved photoemission spectroscopy (ARPES).
    :caption: Contents
 
    getting-started
-   userguide
+   user-guide/index
    reference
-   development
+   contributing
    bibliography

docs/source/userguide.rst → docs/source/user-guide/index.rst

@@ -6,7 +6,7 @@ User Guide
    :class: warning
 
    The user guide is incomplete. For the full list of packages and modules
-   provided by ERLabPy, see :doc:`reference`.
+   provided by ERLabPy, see :doc:`../reference`.
 
 This section contains some examples for getting started with ARPES data analysis
 and visualization.
@@ -27,12 +27,12 @@ Data in ERLabPy are mostly represented by :mod:`xarray` objects
 <https://tutorial.xarray.dev/>`_ are great resources to get started with xarray.
 
 .. toctree::
-   notebooks/io
-   notebooks/indexing
-   notebooks/plotting
-   notebooks/kconv
+   io
+   indexing
+   plotting
+   kconv
 
-Further Reading
+Further reading
 ===============
 
 - `Lectures on scientific computing with Python

pyproject.toml

@@ -129,6 +129,7 @@ allowed_tags = [
     "style",
     "refactor",
     "test",
+    "tests",
 ]
 minor_tags = ["feat"]
 patch_tags = ["fix", "perf"]