Merge pull request #686 from hakonanes/src-layout

Switch to src layout

.github/workflows/perhaps_make_tagged_release_draft.py

@@ -19,7 +19,7 @@
 
 from outdated import check_outdated
 
-with open("../../kikuchipy/__init__.py") as fid:
+with open("../../src/kikuchipy/__init__.py") as fid:
     for line in fid:
         if line.startswith("__version__"):
             branch_version = line.strip().split(" = ")[-1][1:-1]

.github/workflows/perhaps_make_tagged_release_draft.yml

@@ -8,7 +8,7 @@ on:
     branches:
       - main
     paths:
-      - "kikuchipy/__init__.py"
+      - "src/kikuchipy/__init__.py"
 
 jobs:
   make-tagged-release:

.github/workflows/tests.yml

@@ -40,7 +40,7 @@ jobs:
     timeout-minutes: 15
     env:
       MPLBACKEND: agg
-      PYTEST_ARGS: --pyargs kikuchipy --reruns 2 -n 2 --cov=kikuchipy
+      PYTEST_ARGS: --reruns 2 -n 2 --cov=kikuchipy
     strategy:
       fail-fast: false
       matrix:
@@ -108,7 +108,7 @@ jobs:
         if: ${{ matrix.os == 'ubuntu-latest' }}
         continue-on-error: true
         run: |
-          xvfb-run pytest --doctest-modules --doctest-continue-on-failure --ignore-glob=kikuchipy/*/tests kikuchipy/*.py
+          xvfb-run pytest src --doctest-modules --doctest-continue-on-failure
 
       - name: Run tests in a virtual X server environment on Ubuntu
         if: ${{ matrix.os == 'ubuntu-latest' }}

.gitignore

@@ -62,7 +62,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-doc/build/
+doc/_build/
 doc/reference/generated/
 doc/examples/
 sg_execution_times.rst
@@ -105,7 +105,6 @@ ENV/
 
 # Auto changing files
 build/
-src/
 
 # Backport
 .backportrc.json

.pre-commit-config.yaml

@@ -4,7 +4,6 @@ repos:
       rev: 24.8.0
       hooks:
       - id: black
-        language_version: python3.11
       - id: black-jupyter
         files: \.ipynb
         args: [--line-length=77]

README.rst

@@ -2,7 +2,8 @@
 ======
 
 .. |logo| image:: https://raw.githubusercontent.com/pyxem/kikuchipy/develop/doc/_static/logo/plasma_banner.png
-  :width: 40%
+   :width: 50%
+   :target: https://kikuchipy.org
 
 kikuchipy [ki-ko-chi-pai] is a library for processing, simulating, and indexing of
 electron backscatter diffraction (EBSD) patterns in Python.
@@ -71,7 +72,7 @@ Documentation
 
 Refer to the `documentation <https://kikuchipy.org>`__ for detailed installation
 instructions, a user guide, and the
-`changelog <https://kikuchipy.org/en/latest/changelog.html>`__.
+`changelog <https://kikuchipy.org/en/stable/changelog.html>`__.
 
 Installation
 ------------
@@ -89,7 +90,7 @@ You can also visit `PyPI <https://pypi.org/project/kikuchipy>`__,
 `GitHub <https://github.com/pyxem/kikuchipy>`__ to download the source.
 
 Further details are available in the
-`installation guide <https://kikuchipy.org/en/latest/user/installation.html>`__.
+`installation guide <https://kikuchipy.org/en/stable/user/installation.html>`__.
 
 Citing kikuchipy
 ----------------