Rename docs to doc to be consistent with other library of the hyp…

…erspy ecosystem
hyperspy · Dec 1, 2023 · c7f88b4 · c7f88b4
1 parent ceebc97
commit c7f88b4
Show file tree

Hide file tree

Showing 59 changed files with 4 additions and 4 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -7,8 +7,8 @@ jobs:
     # Use the "reusable workflow" from the hyperspy organisation
     uses: hyperspy/.github/.github/workflows/doc.yml@main
     with:
-      doc_path: ./docs
-      doc_build_path: ./docs/_build/html/
+      doc_path: ./doc
+      doc_build_path: ./doc/_build/html/
       pip_extra_doc: all,doc
 
   Push:

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-/docs/_build/*
+/doc/_build/*
 /build/*
 /dist/*
 /RosettaSciIO.egg-info/*

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -16,7 +16,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+  configuration: doc/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:

diff --git a/docs/Makefile → doc/Makefile b/docs/Makefile → doc/Makefile
diff --git a/docs/_static/logo_rec_dark_oct22.png → doc/_static/logo_rec_dark_oct22.png b/docs/_static/logo_rec_dark_oct22.png → doc/_static/logo_rec_dark_oct22.png
diff --git a/docs/_static/logo_rec_dark_oct22.svg → doc/_static/logo_rec_dark_oct22.svg b/docs/_static/logo_rec_dark_oct22.svg → doc/_static/logo_rec_dark_oct22.svg
diff --git a/docs/_static/logo_rec_oct22.png → doc/_static/logo_rec_oct22.png b/docs/_static/logo_rec_oct22.png → doc/_static/logo_rec_oct22.png
diff --git a/docs/_static/logo_rec_oct22.svg → doc/_static/logo_rec_oct22.svg b/docs/_static/logo_rec_oct22.svg → doc/_static/logo_rec_oct22.svg
diff --git a/docs/_static/logo_sq.png → doc/_static/logo_sq.png b/docs/_static/logo_sq.png → doc/_static/logo_sq.png
diff --git a/docs/_static/logo_sq.svg → doc/_static/logo_sq.svg b/docs/_static/logo_sq.svg → doc/_static/logo_sq.svg
diff --git a/docs/api/index.rst → doc/api/index.rst b/docs/api/index.rst → doc/api/index.rst
diff --git a/docs/api/utils.rst → doc/api/utils.rst b/docs/api/utils.rst → doc/api/utils.rst
diff --git a/docs/changes.rst → doc/changes.rst b/docs/changes.rst → doc/changes.rst
diff --git a/docs/conf.py → doc/conf.py b/docs/conf.py → doc/conf.py
diff --git a/docs/contributing.rst → doc/contributing.rst b/docs/contributing.rst → doc/contributing.rst
diff --git a/docs/file_specification/edax/ImageIPR.pdf → doc/file_specification/edax/ImageIPR.pdf b/docs/file_specification/edax/ImageIPR.pdf → doc/file_specification/edax/ImageIPR.pdf
diff --git a/.../file_specification/edax/SPECTRUM-V70.pdf → doc/file_specification/edax/SPECTRUM-V70.pdf b/.../file_specification/edax/SPECTRUM-V70.pdf → doc/file_specification/edax/SPECTRUM-V70.pdf
diff --git a/...ification/edax/SpcMap-spd.file.format.pdf → ...ification/edax/SpcMap-spd.file.format.pdf b/...ification/edax/SpcMap-spd.file.format.pdf → ...ification/edax/SpcMap-spd.file.format.pdf
diff --git a/docs/file_specification/index.rst → doc/file_specification/index.rst b/docs/file_specification/index.rst → doc/file_specification/index.rst
diff --git a/docs/file_specification/ripple-specs.rst → doc/file_specification/ripple-specs.rst b/docs/file_specification/ripple-specs.rst → doc/file_specification/ripple-specs.rst
diff --git a/docs/index.rst → doc/index.rst b/docs/index.rst → doc/index.rst
diff --git a/docs/make.bat → doc/make.bat b/docs/make.bat → doc/make.bat
diff --git a/docs/user_guide/index.rst → doc/user_guide/index.rst b/docs/user_guide/index.rst → doc/user_guide/index.rst
diff --git a/docs/user_guide/install.rst → doc/user_guide/install.rst b/docs/user_guide/install.rst → doc/user_guide/install.rst
diff --git a/docs/user_guide/interoperability.rst → doc/user_guide/interoperability.rst b/docs/user_guide/interoperability.rst → doc/user_guide/interoperability.rst
diff --git a/...ser_guide/supported_formats/blockfile.rst → ...ser_guide/supported_formats/blockfile.rst b/...ser_guide/supported_formats/blockfile.rst → ...ser_guide/supported_formats/blockfile.rst
diff --git a/docs/user_guide/supported_formats/bruker.rst → doc/user_guide/supported_formats/bruker.rst b/docs/user_guide/supported_formats/bruker.rst → doc/user_guide/supported_formats/bruker.rst
diff --git a/docs/user_guide/supported_formats/de5.rst → doc/user_guide/supported_formats/de5.rst b/docs/user_guide/supported_formats/de5.rst → doc/user_guide/supported_formats/de5.rst
diff --git a/docs/user_guide/supported_formats/dens.rst → doc/user_guide/supported_formats/dens.rst b/docs/user_guide/supported_formats/dens.rst → doc/user_guide/supported_formats/dens.rst
diff --git a/...e/supported_formats/digitalmicrograph.rst → ...e/supported_formats/digitalmicrograph.rst b/...e/supported_formats/digitalmicrograph.rst → ...e/supported_formats/digitalmicrograph.rst
diff --git a/...r_guide/supported_formats/digitalsurf.rst → ...r_guide/supported_formats/digitalsurf.rst b/...r_guide/supported_formats/digitalsurf.rst → ...r_guide/supported_formats/digitalsurf.rst
diff --git a/docs/user_guide/supported_formats/edax.rst → doc/user_guide/supported_formats/edax.rst b/docs/user_guide/supported_formats/edax.rst → doc/user_guide/supported_formats/edax.rst
diff --git a/docs/user_guide/supported_formats/emd.rst → doc/user_guide/supported_formats/emd.rst b/docs/user_guide/supported_formats/emd.rst → doc/user_guide/supported_formats/emd.rst
diff --git a/docs/user_guide/supported_formats/empad.rst → doc/user_guide/supported_formats/empad.rst b/docs/user_guide/supported_formats/empad.rst → doc/user_guide/supported_formats/empad.rst
diff --git a/...ser_guide/supported_formats/hamamatsu.rst → ...ser_guide/supported_formats/hamamatsu.rst b/...ser_guide/supported_formats/hamamatsu.rst → ...ser_guide/supported_formats/hamamatsu.rst
diff --git a/docs/user_guide/supported_formats/hspy.rst → doc/user_guide/supported_formats/hspy.rst b/docs/user_guide/supported_formats/hspy.rst → doc/user_guide/supported_formats/hspy.rst
diff --git a/docs/user_guide/supported_formats/image.rst → doc/user_guide/supported_formats/image.rst b/docs/user_guide/supported_formats/image.rst → doc/user_guide/supported_formats/image.rst
diff --git a/docs/user_guide/supported_formats/index.rst → doc/user_guide/supported_formats/index.rst b/docs/user_guide/supported_formats/index.rst → doc/user_guide/supported_formats/index.rst
diff --git a/docs/user_guide/supported_formats/jeol.rst → doc/user_guide/supported_formats/jeol.rst b/docs/user_guide/supported_formats/jeol.rst → doc/user_guide/supported_formats/jeol.rst
diff --git a/...ser_guide/supported_formats/jobinyvon.rst → ...ser_guide/supported_formats/jobinyvon.rst b/...ser_guide/supported_formats/jobinyvon.rst → ...ser_guide/supported_formats/jobinyvon.rst
diff --git a/docs/user_guide/supported_formats/mrc.rst → doc/user_guide/supported_formats/mrc.rst b/docs/user_guide/supported_formats/mrc.rst → doc/user_guide/supported_formats/mrc.rst
diff --git a/docs/user_guide/supported_formats/mrcz.rst → doc/user_guide/supported_formats/mrcz.rst b/docs/user_guide/supported_formats/mrcz.rst → doc/user_guide/supported_formats/mrcz.rst
diff --git a/docs/user_guide/supported_formats/msa.rst → doc/user_guide/supported_formats/msa.rst b/docs/user_guide/supported_formats/msa.rst → doc/user_guide/supported_formats/msa.rst
diff --git a/docs/user_guide/supported_formats/netcdf.rst → doc/user_guide/supported_formats/netcdf.rst b/docs/user_guide/supported_formats/netcdf.rst → doc/user_guide/supported_formats/netcdf.rst
diff --git a/docs/user_guide/supported_formats/nexus.rst → doc/user_guide/supported_formats/nexus.rst b/docs/user_guide/supported_formats/nexus.rst → doc/user_guide/supported_formats/nexus.rst
diff --git a/...ser_guide/supported_formats/pantarhei.rst → ...ser_guide/supported_formats/pantarhei.rst b/...ser_guide/supported_formats/pantarhei.rst → ...ser_guide/supported_formats/pantarhei.rst
diff --git a/docs/user_guide/supported_formats/phenom.rst → doc/user_guide/supported_formats/phenom.rst b/docs/user_guide/supported_formats/phenom.rst → doc/user_guide/supported_formats/phenom.rst
diff --git a/...er_guide/supported_formats/protochips.rst → ...er_guide/supported_formats/protochips.rst b/...er_guide/supported_formats/protochips.rst → ...er_guide/supported_formats/protochips.rst
diff --git a/...ide/supported_formats/quantumdetector.rst → ...ide/supported_formats/quantumdetector.rst b/...ide/supported_formats/quantumdetector.rst → ...ide/supported_formats/quantumdetector.rst
diff --git a/...user_guide/supported_formats/renishaw.rst → ...user_guide/supported_formats/renishaw.rst b/...user_guide/supported_formats/renishaw.rst → ...user_guide/supported_formats/renishaw.rst
diff --git a/docs/user_guide/supported_formats/ripple.rst → doc/user_guide/supported_formats/ripple.rst b/docs/user_guide/supported_formats/ripple.rst → doc/user_guide/supported_formats/ripple.rst
diff --git a/docs/user_guide/supported_formats/semper.rst → doc/user_guide/supported_formats/semper.rst b/docs/user_guide/supported_formats/semper.rst → doc/user_guide/supported_formats/semper.rst
diff --git a/...e/supported_formats/supported_formats.rst → ...e/supported_formats/supported_formats.rst b/...e/supported_formats/supported_formats.rst → ...e/supported_formats/supported_formats.rst
diff --git a/docs/user_guide/supported_formats/tia.rst → doc/user_guide/supported_formats/tia.rst b/docs/user_guide/supported_formats/tia.rst → doc/user_guide/supported_formats/tia.rst
diff --git a/docs/user_guide/supported_formats/tiff.rst → doc/user_guide/supported_formats/tiff.rst b/docs/user_guide/supported_formats/tiff.rst → doc/user_guide/supported_formats/tiff.rst
diff --git a/...user_guide/supported_formats/trivista.rst → ...user_guide/supported_formats/trivista.rst b/...user_guide/supported_formats/trivista.rst → ...user_guide/supported_formats/trivista.rst
diff --git a/docs/user_guide/supported_formats/tvips.rst → doc/user_guide/supported_formats/tvips.rst b/docs/user_guide/supported_formats/tvips.rst → doc/user_guide/supported_formats/tvips.rst
diff --git a/docs/user_guide/supported_formats/usid.rst → doc/user_guide/supported_formats/usid.rst b/docs/user_guide/supported_formats/usid.rst → doc/user_guide/supported_formats/usid.rst
diff --git a/docs/user_guide/supported_formats/zspy.rst → doc/user_guide/supported_formats/zspy.rst b/docs/user_guide/supported_formats/zspy.rst → doc/user_guide/supported_formats/zspy.rst