From e544b331b80a1c43d6d3f134339d7e989138db42 Mon Sep 17 00:00:00 2001 From: Eric Prestat Date: Fri, 1 Dec 2023 18:00:39 +0100 Subject: [PATCH] Rename `docs` to `doc` to be consistent with other library of the hyperspy ecosystem --- .github/workflows/docs.yml | 4 ++-- .gitignore | 2 +- .readthedocs.yaml | 2 +- {docs => doc}/Makefile | 0 {docs => doc}/_static/logo_rec_dark_oct22.png | Bin {docs => doc}/_static/logo_rec_dark_oct22.svg | 0 {docs => doc}/_static/logo_rec_oct22.png | Bin {docs => doc}/_static/logo_rec_oct22.svg | 0 {docs => doc}/_static/logo_sq.png | Bin {docs => doc}/_static/logo_sq.svg | 0 {docs => doc}/api/index.rst | 0 {docs => doc}/api/utils.rst | 0 {docs => doc}/changes.rst | 0 {docs => doc}/conf.py | 0 {docs => doc}/contributing.rst | 0 {docs => doc}/file_specification/edax/ImageIPR.pdf | Bin .../file_specification/edax/SPECTRUM-V70.pdf | Bin .../edax/SpcMap-spd.file.format.pdf | Bin {docs => doc}/file_specification/index.rst | 0 {docs => doc}/file_specification/ripple-specs.rst | 0 {docs => doc}/index.rst | 0 {docs => doc}/make.bat | 0 {docs => doc}/user_guide/index.rst | 0 {docs => doc}/user_guide/install.rst | 0 {docs => doc}/user_guide/interoperability.rst | 0 .../user_guide/supported_formats/blockfile.rst | 0 .../user_guide/supported_formats/bruker.rst | 0 {docs => doc}/user_guide/supported_formats/de5.rst | 0 {docs => doc}/user_guide/supported_formats/dens.rst | 0 .../supported_formats/digitalmicrograph.rst | 0 .../user_guide/supported_formats/digitalsurf.rst | 0 {docs => doc}/user_guide/supported_formats/edax.rst | 0 {docs => doc}/user_guide/supported_formats/emd.rst | 0 .../user_guide/supported_formats/empad.rst | 0 .../user_guide/supported_formats/hamamatsu.rst | 0 {docs => doc}/user_guide/supported_formats/hspy.rst | 0 .../user_guide/supported_formats/image.rst | 0 .../user_guide/supported_formats/index.rst | 0 {docs => doc}/user_guide/supported_formats/jeol.rst | 0 .../user_guide/supported_formats/jobinyvon.rst | 0 {docs => doc}/user_guide/supported_formats/mrc.rst | 0 {docs => doc}/user_guide/supported_formats/mrcz.rst | 0 {docs => doc}/user_guide/supported_formats/msa.rst | 0 .../user_guide/supported_formats/netcdf.rst | 0 .../user_guide/supported_formats/nexus.rst | 0 .../user_guide/supported_formats/pantarhei.rst | 0 .../user_guide/supported_formats/phenom.rst | 0 .../user_guide/supported_formats/protochips.rst | 0 .../supported_formats/quantumdetector.rst | 0 .../user_guide/supported_formats/renishaw.rst | 0 .../user_guide/supported_formats/ripple.rst | 0 .../user_guide/supported_formats/semper.rst | 0 .../supported_formats/supported_formats.rst | 0 {docs => doc}/user_guide/supported_formats/tia.rst | 0 {docs => doc}/user_guide/supported_formats/tiff.rst | 0 .../user_guide/supported_formats/trivista.rst | 0 .../user_guide/supported_formats/tvips.rst | 0 {docs => doc}/user_guide/supported_formats/usid.rst | 0 {docs => doc}/user_guide/supported_formats/zspy.rst | 0 59 files changed, 4 insertions(+), 4 deletions(-) rename {docs => doc}/Makefile (100%) rename {docs => doc}/_static/logo_rec_dark_oct22.png (100%) rename {docs => doc}/_static/logo_rec_dark_oct22.svg (100%) rename {docs => doc}/_static/logo_rec_oct22.png (100%) rename {docs => doc}/_static/logo_rec_oct22.svg (100%) rename {docs => doc}/_static/logo_sq.png (100%) rename {docs => doc}/_static/logo_sq.svg (100%) rename {docs => doc}/api/index.rst (100%) rename {docs => doc}/api/utils.rst (100%) rename {docs => doc}/changes.rst (100%) rename {docs => doc}/conf.py (100%) rename {docs => doc}/contributing.rst (100%) rename {docs => doc}/file_specification/edax/ImageIPR.pdf (100%) rename {docs => doc}/file_specification/edax/SPECTRUM-V70.pdf (100%) rename {docs => doc}/file_specification/edax/SpcMap-spd.file.format.pdf (100%) rename {docs => doc}/file_specification/index.rst (100%) rename {docs => doc}/file_specification/ripple-specs.rst (100%) rename {docs => doc}/index.rst (100%) rename {docs => doc}/make.bat (100%) rename {docs => doc}/user_guide/index.rst (100%) rename {docs => doc}/user_guide/install.rst (100%) rename {docs => doc}/user_guide/interoperability.rst (100%) rename {docs => doc}/user_guide/supported_formats/blockfile.rst (100%) rename {docs => doc}/user_guide/supported_formats/bruker.rst (100%) rename {docs => doc}/user_guide/supported_formats/de5.rst (100%) rename {docs => doc}/user_guide/supported_formats/dens.rst (100%) rename {docs => doc}/user_guide/supported_formats/digitalmicrograph.rst (100%) rename {docs => doc}/user_guide/supported_formats/digitalsurf.rst (100%) rename {docs => doc}/user_guide/supported_formats/edax.rst (100%) rename {docs => doc}/user_guide/supported_formats/emd.rst (100%) rename {docs => doc}/user_guide/supported_formats/empad.rst (100%) rename {docs => doc}/user_guide/supported_formats/hamamatsu.rst (100%) rename {docs => doc}/user_guide/supported_formats/hspy.rst (100%) rename {docs => doc}/user_guide/supported_formats/image.rst (100%) rename {docs => doc}/user_guide/supported_formats/index.rst (100%) rename {docs => doc}/user_guide/supported_formats/jeol.rst (100%) rename {docs => doc}/user_guide/supported_formats/jobinyvon.rst (100%) rename {docs => doc}/user_guide/supported_formats/mrc.rst (100%) rename {docs => doc}/user_guide/supported_formats/mrcz.rst (100%) rename {docs => doc}/user_guide/supported_formats/msa.rst (100%) rename {docs => doc}/user_guide/supported_formats/netcdf.rst (100%) rename {docs => doc}/user_guide/supported_formats/nexus.rst (100%) rename {docs => doc}/user_guide/supported_formats/pantarhei.rst (100%) rename {docs => doc}/user_guide/supported_formats/phenom.rst (100%) rename {docs => doc}/user_guide/supported_formats/protochips.rst (100%) rename {docs => doc}/user_guide/supported_formats/quantumdetector.rst (100%) rename {docs => doc}/user_guide/supported_formats/renishaw.rst (100%) rename {docs => doc}/user_guide/supported_formats/ripple.rst (100%) rename {docs => doc}/user_guide/supported_formats/semper.rst (100%) rename {docs => doc}/user_guide/supported_formats/supported_formats.rst (100%) rename {docs => doc}/user_guide/supported_formats/tia.rst (100%) rename {docs => doc}/user_guide/supported_formats/tiff.rst (100%) rename {docs => doc}/user_guide/supported_formats/trivista.rst (100%) rename {docs => doc}/user_guide/supported_formats/tvips.rst (100%) rename {docs => doc}/user_guide/supported_formats/usid.rst (100%) rename {docs => doc}/user_guide/supported_formats/zspy.rst (100%) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9e25bdef2..e6d4e7b93 100644 --- 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 index 8d3253e92..0d9467764 100644 --- 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 index 8a1208617..e1ffdd5e9 100644 --- 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 b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/_static/logo_rec_dark_oct22.png b/doc/_static/logo_rec_dark_oct22.png similarity index 100% rename from docs/_static/logo_rec_dark_oct22.png rename to doc/_static/logo_rec_dark_oct22.png diff --git a/docs/_static/logo_rec_dark_oct22.svg b/doc/_static/logo_rec_dark_oct22.svg similarity index 100% rename from docs/_static/logo_rec_dark_oct22.svg rename to doc/_static/logo_rec_dark_oct22.svg diff --git a/docs/_static/logo_rec_oct22.png b/doc/_static/logo_rec_oct22.png similarity index 100% rename from docs/_static/logo_rec_oct22.png rename to doc/_static/logo_rec_oct22.png diff --git a/docs/_static/logo_rec_oct22.svg b/doc/_static/logo_rec_oct22.svg similarity index 100% rename from docs/_static/logo_rec_oct22.svg rename to doc/_static/logo_rec_oct22.svg diff --git a/docs/_static/logo_sq.png b/doc/_static/logo_sq.png similarity index 100% rename from docs/_static/logo_sq.png rename to doc/_static/logo_sq.png diff --git a/docs/_static/logo_sq.svg b/doc/_static/logo_sq.svg similarity index 100% rename from docs/_static/logo_sq.svg rename to doc/_static/logo_sq.svg diff --git a/docs/api/index.rst b/doc/api/index.rst similarity index 100% rename from docs/api/index.rst rename to doc/api/index.rst diff --git a/docs/api/utils.rst b/doc/api/utils.rst similarity index 100% rename from docs/api/utils.rst rename to doc/api/utils.rst diff --git a/docs/changes.rst b/doc/changes.rst similarity index 100% rename from docs/changes.rst rename to doc/changes.rst diff --git a/docs/conf.py b/doc/conf.py similarity index 100% rename from docs/conf.py rename to doc/conf.py diff --git a/docs/contributing.rst b/doc/contributing.rst similarity index 100% rename from docs/contributing.rst rename to doc/contributing.rst diff --git a/docs/file_specification/edax/ImageIPR.pdf b/doc/file_specification/edax/ImageIPR.pdf similarity index 100% rename from docs/file_specification/edax/ImageIPR.pdf rename to doc/file_specification/edax/ImageIPR.pdf diff --git a/docs/file_specification/edax/SPECTRUM-V70.pdf b/doc/file_specification/edax/SPECTRUM-V70.pdf similarity index 100% rename from docs/file_specification/edax/SPECTRUM-V70.pdf rename to doc/file_specification/edax/SPECTRUM-V70.pdf diff --git a/docs/file_specification/edax/SpcMap-spd.file.format.pdf b/doc/file_specification/edax/SpcMap-spd.file.format.pdf similarity index 100% rename from docs/file_specification/edax/SpcMap-spd.file.format.pdf rename to doc/file_specification/edax/SpcMap-spd.file.format.pdf diff --git a/docs/file_specification/index.rst b/doc/file_specification/index.rst similarity index 100% rename from docs/file_specification/index.rst rename to doc/file_specification/index.rst diff --git a/docs/file_specification/ripple-specs.rst b/doc/file_specification/ripple-specs.rst similarity index 100% rename from docs/file_specification/ripple-specs.rst rename to doc/file_specification/ripple-specs.rst diff --git a/docs/index.rst b/doc/index.rst similarity index 100% rename from docs/index.rst rename to doc/index.rst diff --git a/docs/make.bat b/doc/make.bat similarity index 100% rename from docs/make.bat rename to doc/make.bat diff --git a/docs/user_guide/index.rst b/doc/user_guide/index.rst similarity index 100% rename from docs/user_guide/index.rst rename to doc/user_guide/index.rst diff --git a/docs/user_guide/install.rst b/doc/user_guide/install.rst similarity index 100% rename from docs/user_guide/install.rst rename to doc/user_guide/install.rst diff --git a/docs/user_guide/interoperability.rst b/doc/user_guide/interoperability.rst similarity index 100% rename from docs/user_guide/interoperability.rst rename to doc/user_guide/interoperability.rst diff --git a/docs/user_guide/supported_formats/blockfile.rst b/doc/user_guide/supported_formats/blockfile.rst similarity index 100% rename from docs/user_guide/supported_formats/blockfile.rst rename to doc/user_guide/supported_formats/blockfile.rst diff --git a/docs/user_guide/supported_formats/bruker.rst b/doc/user_guide/supported_formats/bruker.rst similarity index 100% rename from docs/user_guide/supported_formats/bruker.rst rename to doc/user_guide/supported_formats/bruker.rst diff --git a/docs/user_guide/supported_formats/de5.rst b/doc/user_guide/supported_formats/de5.rst similarity index 100% rename from docs/user_guide/supported_formats/de5.rst rename to doc/user_guide/supported_formats/de5.rst diff --git a/docs/user_guide/supported_formats/dens.rst b/doc/user_guide/supported_formats/dens.rst similarity index 100% rename from docs/user_guide/supported_formats/dens.rst rename to doc/user_guide/supported_formats/dens.rst diff --git a/docs/user_guide/supported_formats/digitalmicrograph.rst b/doc/user_guide/supported_formats/digitalmicrograph.rst similarity index 100% rename from docs/user_guide/supported_formats/digitalmicrograph.rst rename to doc/user_guide/supported_formats/digitalmicrograph.rst diff --git a/docs/user_guide/supported_formats/digitalsurf.rst b/doc/user_guide/supported_formats/digitalsurf.rst similarity index 100% rename from docs/user_guide/supported_formats/digitalsurf.rst rename to doc/user_guide/supported_formats/digitalsurf.rst diff --git a/docs/user_guide/supported_formats/edax.rst b/doc/user_guide/supported_formats/edax.rst similarity index 100% rename from docs/user_guide/supported_formats/edax.rst rename to doc/user_guide/supported_formats/edax.rst diff --git a/docs/user_guide/supported_formats/emd.rst b/doc/user_guide/supported_formats/emd.rst similarity index 100% rename from docs/user_guide/supported_formats/emd.rst rename to doc/user_guide/supported_formats/emd.rst diff --git a/docs/user_guide/supported_formats/empad.rst b/doc/user_guide/supported_formats/empad.rst similarity index 100% rename from docs/user_guide/supported_formats/empad.rst rename to doc/user_guide/supported_formats/empad.rst diff --git a/docs/user_guide/supported_formats/hamamatsu.rst b/doc/user_guide/supported_formats/hamamatsu.rst similarity index 100% rename from docs/user_guide/supported_formats/hamamatsu.rst rename to doc/user_guide/supported_formats/hamamatsu.rst diff --git a/docs/user_guide/supported_formats/hspy.rst b/doc/user_guide/supported_formats/hspy.rst similarity index 100% rename from docs/user_guide/supported_formats/hspy.rst rename to doc/user_guide/supported_formats/hspy.rst diff --git a/docs/user_guide/supported_formats/image.rst b/doc/user_guide/supported_formats/image.rst similarity index 100% rename from docs/user_guide/supported_formats/image.rst rename to doc/user_guide/supported_formats/image.rst diff --git a/docs/user_guide/supported_formats/index.rst b/doc/user_guide/supported_formats/index.rst similarity index 100% rename from docs/user_guide/supported_formats/index.rst rename to doc/user_guide/supported_formats/index.rst diff --git a/docs/user_guide/supported_formats/jeol.rst b/doc/user_guide/supported_formats/jeol.rst similarity index 100% rename from docs/user_guide/supported_formats/jeol.rst rename to doc/user_guide/supported_formats/jeol.rst diff --git a/docs/user_guide/supported_formats/jobinyvon.rst b/doc/user_guide/supported_formats/jobinyvon.rst similarity index 100% rename from docs/user_guide/supported_formats/jobinyvon.rst rename to doc/user_guide/supported_formats/jobinyvon.rst diff --git a/docs/user_guide/supported_formats/mrc.rst b/doc/user_guide/supported_formats/mrc.rst similarity index 100% rename from docs/user_guide/supported_formats/mrc.rst rename to doc/user_guide/supported_formats/mrc.rst diff --git a/docs/user_guide/supported_formats/mrcz.rst b/doc/user_guide/supported_formats/mrcz.rst similarity index 100% rename from docs/user_guide/supported_formats/mrcz.rst rename to doc/user_guide/supported_formats/mrcz.rst diff --git a/docs/user_guide/supported_formats/msa.rst b/doc/user_guide/supported_formats/msa.rst similarity index 100% rename from docs/user_guide/supported_formats/msa.rst rename to doc/user_guide/supported_formats/msa.rst diff --git a/docs/user_guide/supported_formats/netcdf.rst b/doc/user_guide/supported_formats/netcdf.rst similarity index 100% rename from docs/user_guide/supported_formats/netcdf.rst rename to doc/user_guide/supported_formats/netcdf.rst diff --git a/docs/user_guide/supported_formats/nexus.rst b/doc/user_guide/supported_formats/nexus.rst similarity index 100% rename from docs/user_guide/supported_formats/nexus.rst rename to doc/user_guide/supported_formats/nexus.rst diff --git a/docs/user_guide/supported_formats/pantarhei.rst b/doc/user_guide/supported_formats/pantarhei.rst similarity index 100% rename from docs/user_guide/supported_formats/pantarhei.rst rename to doc/user_guide/supported_formats/pantarhei.rst diff --git a/docs/user_guide/supported_formats/phenom.rst b/doc/user_guide/supported_formats/phenom.rst similarity index 100% rename from docs/user_guide/supported_formats/phenom.rst rename to doc/user_guide/supported_formats/phenom.rst diff --git a/docs/user_guide/supported_formats/protochips.rst b/doc/user_guide/supported_formats/protochips.rst similarity index 100% rename from docs/user_guide/supported_formats/protochips.rst rename to doc/user_guide/supported_formats/protochips.rst diff --git a/docs/user_guide/supported_formats/quantumdetector.rst b/doc/user_guide/supported_formats/quantumdetector.rst similarity index 100% rename from docs/user_guide/supported_formats/quantumdetector.rst rename to doc/user_guide/supported_formats/quantumdetector.rst diff --git a/docs/user_guide/supported_formats/renishaw.rst b/doc/user_guide/supported_formats/renishaw.rst similarity index 100% rename from docs/user_guide/supported_formats/renishaw.rst rename to doc/user_guide/supported_formats/renishaw.rst diff --git a/docs/user_guide/supported_formats/ripple.rst b/doc/user_guide/supported_formats/ripple.rst similarity index 100% rename from docs/user_guide/supported_formats/ripple.rst rename to doc/user_guide/supported_formats/ripple.rst diff --git a/docs/user_guide/supported_formats/semper.rst b/doc/user_guide/supported_formats/semper.rst similarity index 100% rename from docs/user_guide/supported_formats/semper.rst rename to doc/user_guide/supported_formats/semper.rst diff --git a/docs/user_guide/supported_formats/supported_formats.rst b/doc/user_guide/supported_formats/supported_formats.rst similarity index 100% rename from docs/user_guide/supported_formats/supported_formats.rst rename to doc/user_guide/supported_formats/supported_formats.rst diff --git a/docs/user_guide/supported_formats/tia.rst b/doc/user_guide/supported_formats/tia.rst similarity index 100% rename from docs/user_guide/supported_formats/tia.rst rename to doc/user_guide/supported_formats/tia.rst diff --git a/docs/user_guide/supported_formats/tiff.rst b/doc/user_guide/supported_formats/tiff.rst similarity index 100% rename from docs/user_guide/supported_formats/tiff.rst rename to doc/user_guide/supported_formats/tiff.rst diff --git a/docs/user_guide/supported_formats/trivista.rst b/doc/user_guide/supported_formats/trivista.rst similarity index 100% rename from docs/user_guide/supported_formats/trivista.rst rename to doc/user_guide/supported_formats/trivista.rst diff --git a/docs/user_guide/supported_formats/tvips.rst b/doc/user_guide/supported_formats/tvips.rst similarity index 100% rename from docs/user_guide/supported_formats/tvips.rst rename to doc/user_guide/supported_formats/tvips.rst diff --git a/docs/user_guide/supported_formats/usid.rst b/doc/user_guide/supported_formats/usid.rst similarity index 100% rename from docs/user_guide/supported_formats/usid.rst rename to doc/user_guide/supported_formats/usid.rst diff --git a/docs/user_guide/supported_formats/zspy.rst b/doc/user_guide/supported_formats/zspy.rst similarity index 100% rename from docs/user_guide/supported_formats/zspy.rst rename to doc/user_guide/supported_formats/zspy.rst