diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/manual/Makefile b/docs/manual/Makefile similarity index 100% rename from doc/manual/Makefile rename to docs/manual/Makefile diff --git a/doc/manual/README.txt b/docs/manual/README.txt similarity index 100% rename from doc/manual/README.txt rename to docs/manual/README.txt diff --git a/doc/manual/acknowledgements.texinfo b/docs/manual/acknowledgements.texinfo similarity index 100% rename from doc/manual/acknowledgements.texinfo rename to docs/manual/acknowledgements.texinfo diff --git a/doc/manual/disclaimer.texinfo b/docs/manual/disclaimer.texinfo similarity index 100% rename from doc/manual/disclaimer.texinfo rename to docs/manual/disclaimer.texinfo diff --git a/doc/manual/images/aspirin_smear.png b/docs/manual/images/aspirin_smear.png similarity index 100% rename from doc/manual/images/aspirin_smear.png rename to docs/manual/images/aspirin_smear.png diff --git a/doc/manual/images/aspirin_stretch.png b/docs/manual/images/aspirin_stretch.png similarity index 100% rename from doc/manual/images/aspirin_stretch.png rename to docs/manual/images/aspirin_stretch.png diff --git a/doc/manual/images/ex_tutorial_bar.png b/docs/manual/images/ex_tutorial_bar.png similarity index 100% rename from doc/manual/images/ex_tutorial_bar.png rename to docs/manual/images/ex_tutorial_bar.png diff --git a/doc/manual/images/ex_tutorial_download.png b/docs/manual/images/ex_tutorial_download.png similarity index 100% rename from doc/manual/images/ex_tutorial_download.png rename to docs/manual/images/ex_tutorial_download.png diff --git a/doc/manual/images/ex_tutorial_params.png b/docs/manual/images/ex_tutorial_params.png similarity index 100% rename from doc/manual/images/ex_tutorial_params.png rename to docs/manual/images/ex_tutorial_params.png diff --git a/doc/manual/images/ex_tutorial_shape_download.png b/docs/manual/images/ex_tutorial_shape_download.png similarity index 100% rename from doc/manual/images/ex_tutorial_shape_download.png rename to docs/manual/images/ex_tutorial_shape_download.png diff --git a/doc/manual/images/ex_tutorial_shape_sphere_zoomed.png b/docs/manual/images/ex_tutorial_shape_sphere_zoomed.png similarity index 100% rename from doc/manual/images/ex_tutorial_shape_sphere_zoomed.png rename to docs/manual/images/ex_tutorial_shape_sphere_zoomed.png diff --git a/doc/manual/images/ex_tutorial_stretch.png b/docs/manual/images/ex_tutorial_stretch.png similarity index 100% rename from doc/manual/images/ex_tutorial_stretch.png rename to docs/manual/images/ex_tutorial_stretch.png diff --git a/doc/manual/images/ex_tutorial_temp.png b/docs/manual/images/ex_tutorial_temp.png similarity index 100% rename from doc/manual/images/ex_tutorial_temp.png rename to docs/manual/images/ex_tutorial_temp.png diff --git a/doc/manual/images/morph_ex1.png b/docs/manual/images/morph_ex1.png similarity index 100% rename from doc/manual/images/morph_ex1.png rename to docs/manual/images/morph_ex1.png diff --git a/doc/manual/images/morph_ex2.png b/docs/manual/images/morph_ex2.png similarity index 100% rename from doc/manual/images/morph_ex2.png rename to docs/manual/images/morph_ex2.png diff --git a/doc/manual/images/nacl_example.agr b/docs/manual/images/nacl_example.agr similarity index 100% rename from doc/manual/images/nacl_example.agr rename to docs/manual/images/nacl_example.agr diff --git a/doc/manual/images/nacl_example.png b/docs/manual/images/nacl_example.png similarity index 100% rename from doc/manual/images/nacl_example.png rename to docs/manual/images/nacl_example.png diff --git a/doc/manual/images/pdfmorph_example.agr b/docs/manual/images/pdfmorph_example.agr similarity index 100% rename from doc/manual/images/pdfmorph_example.agr rename to docs/manual/images/pdfmorph_example.agr diff --git a/doc/manual/images/pdfmorph_example.png b/docs/manual/images/pdfmorph_example.png similarity index 100% rename from doc/manual/images/pdfmorph_example.png rename to docs/manual/images/pdfmorph_example.png diff --git a/doc/manual/images/pdfmorph_example.xcf b/docs/manual/images/pdfmorph_example.xcf similarity index 100% rename from doc/manual/images/pdfmorph_example.xcf rename to docs/manual/images/pdfmorph_example.xcf diff --git a/doc/manual/images/pdfmorph_smear.png b/docs/manual/images/pdfmorph_smear.png similarity index 100% rename from doc/manual/images/pdfmorph_smear.png rename to docs/manual/images/pdfmorph_smear.png diff --git a/doc/manual/images/pdfmorph_smear2.png b/docs/manual/images/pdfmorph_smear2.png similarity index 100% rename from doc/manual/images/pdfmorph_smear2.png rename to docs/manual/images/pdfmorph_smear2.png diff --git a/doc/manual/images/pdfmorph_stretch.png b/docs/manual/images/pdfmorph_stretch.png similarity index 100% rename from doc/manual/images/pdfmorph_stretch.png rename to docs/manual/images/pdfmorph_stretch.png diff --git a/doc/manual/images/qs_tutorial_download.png b/docs/manual/images/qs_tutorial_download.png similarity index 100% rename from doc/manual/images/qs_tutorial_download.png rename to docs/manual/images/qs_tutorial_download.png diff --git a/doc/manual/images/qs_tutorial_morphed.png b/docs/manual/images/qs_tutorial_morphed.png similarity index 100% rename from doc/manual/images/qs_tutorial_morphed.png rename to docs/manual/images/qs_tutorial_morphed.png diff --git a/doc/manual/images/qs_tutorial_scaled.png b/docs/manual/images/qs_tutorial_scaled.png similarity index 100% rename from doc/manual/images/qs_tutorial_scaled.png rename to docs/manual/images/qs_tutorial_scaled.png diff --git a/doc/manual/images/qs_tutorial_unmorphed.png b/docs/manual/images/qs_tutorial_unmorphed.png similarity index 100% rename from doc/manual/images/qs_tutorial_unmorphed.png rename to docs/manual/images/qs_tutorial_unmorphed.png diff --git a/doc/manual/make.bat b/docs/manual/make.bat similarity index 100% rename from doc/manual/make.bat rename to docs/manual/make.bat diff --git a/doc/manual/pdfmorph.pdf b/docs/manual/pdfmorph.pdf similarity index 100% rename from doc/manual/pdfmorph.pdf rename to docs/manual/pdfmorph.pdf diff --git a/doc/manual/pdfmorph.texinfo b/docs/manual/pdfmorph.texinfo similarity index 100% rename from doc/manual/pdfmorph.texinfo rename to docs/manual/pdfmorph.texinfo diff --git a/doc/manual/redistribution.texinfo b/docs/manual/redistribution.texinfo similarity index 100% rename from doc/manual/redistribution.texinfo rename to docs/manual/redistribution.texinfo diff --git a/doc/source/_static/.placeholder b/docs/source/_static/.placeholder similarity index 100% rename from doc/source/_static/.placeholder rename to docs/source/_static/.placeholder diff --git a/doc/source/api/diffpy.morph.morph_helpers.rst b/docs/source/api/diffpy.morph.morph_helpers.rst similarity index 94% rename from doc/source/api/diffpy.morph.morph_helpers.rst rename to docs/source/api/diffpy.morph.morph_helpers.rst index e8889166..4651f506 100644 --- a/doc/source/api/diffpy.morph.morph_helpers.rst +++ b/docs/source/api/diffpy.morph.morph_helpers.rst @@ -1,6 +1,6 @@ :tocdepth: -1 -diffpy.morph.morph_helpers package +diffpy.morph.morp_helpers package ================================== .. automodule:: diffpy.morph.morph_helpers @@ -11,18 +11,18 @@ diffpy.morph.morph_helpers package Submodules ---------- -diffpy.morph.morph_helpers.transformpdftordf module +diffpy.morph.morph_helpers.transformrdftopdf module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morph_helpers.transformpdftordf +.. automodule:: diffpy.morph.morph_helpers.transformrdftopdf :members: :undoc-members: :show-inheritance: -diffpy.morph.morph_helpers.transformrdftopdf module +diffpy.morph.morph_helpers.transformpdftordf module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morph_helpers.transformrdftopdf +.. automodule:: diffpy.morph.morph_helpers.transformpdftordf :members: :undoc-members: :show-inheritance: diff --git a/doc/source/api/diffpy.morph.morphs.rst b/docs/source/api/diffpy.morph.morphs.rst similarity index 84% rename from doc/source/api/diffpy.morph.morphs.rst rename to docs/source/api/diffpy.morph.morphs.rst index c4b55150..2baaa24e 100644 --- a/doc/source/api/diffpy.morph.morphs.rst +++ b/docs/source/api/diffpy.morph.morphs.rst @@ -11,42 +11,58 @@ diffpy.morph.morphs package Submodules ---------- -diffpy.morph.morphs.morphishape module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +diffpy.morph.morphs.morphscale module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphishape +.. automodule:: diffpy.morph.morphs.morphscale :members: :undoc-members: :show-inheritance: -diffpy.morph.morphs.morphchain module +diffpy.morph.morphs.morphshape module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphchain +.. automodule:: diffpy.morph.morphs.morphshape :members: :undoc-members: :show-inheritance: -diffpy.morph.morphs.morphresolution module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +diffpy.morph.morphs.morphshift module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphresolution +.. automodule:: diffpy.morph.morphs.morphshift :members: :undoc-members: :show-inheritance: -diffpy.morph.morphs.morphshape module +diffpy.morph.morphs.morphfuncy module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphshape +.. automodule:: diffpy.morph.morphs.morphfuncy :members: :undoc-members: :show-inheritance: -diffpy.morph.morphs.morphshift module +diffpy.morph.morphs.morphchain module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphshift +.. automodule:: diffpy.morph.morphs.morphchain + :members: + :undoc-members: + :show-inheritance: + +diffpy.morph.morphs.morphresolution module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.morph.morphs.morphresolution + :members: + :undoc-members: + :show-inheritance: + +diffpy.morph.morphs.morphstretch module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.morph.morphs.morphstretch :members: :undoc-members: :show-inheritance: @@ -59,34 +75,34 @@ diffpy.morph.morphs.morph module :undoc-members: :show-inheritance: -diffpy.morph.morphs.morphrgrid module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +diffpy.morph.morphs.morphsqueeze module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphrgrid +.. automodule:: diffpy.morph.morphs.morphsqueeze :members: :undoc-members: :show-inheritance: -diffpy.morph.morphs.morphsmear module +diffpy.morph.morphs.morphrgrid module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphsmear +.. automodule:: diffpy.morph.morphs.morphrgrid :members: :undoc-members: :show-inheritance: -diffpy.morph.morphs.morphstretch module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +diffpy.morph.morphs.morphishape module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphstretch +.. automodule:: diffpy.morph.morphs.morphishape :members: :undoc-members: :show-inheritance: -diffpy.morph.morphs.morphscale module +diffpy.morph.morphs.morphsmear module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.morphs.morphscale +.. automodule:: diffpy.morph.morphs.morphsmear :members: :undoc-members: :show-inheritance: diff --git a/doc/source/api/diffpy.morph.rst b/docs/source/api/diffpy.morph.rst similarity index 89% rename from doc/source/api/diffpy.morph.rst rename to docs/source/api/diffpy.morph.rst index 01046993..0c2381a8 100644 --- a/doc/source/api/diffpy.morph.rst +++ b/docs/source/api/diffpy.morph.rst @@ -14,8 +14,8 @@ Subpackages .. toctree:: :titlesonly: - diffpy.morph.morphs diffpy.morph.morph_helpers + diffpy.morph.morphs Submodules ---------- @@ -36,18 +36,18 @@ diffpy.morph.morph_api module :undoc-members: :show-inheritance: -diffpy.morph.refine module -^^^^^^^^^^^^^^^^^^^^^^^^^^ +diffpy.morph.tools module +^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.refine +.. automodule:: diffpy.morph.tools :members: :undoc-members: :show-inheritance: -diffpy.morph.tools module -^^^^^^^^^^^^^^^^^^^^^^^^^ +diffpy.morph.morphpy module +^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.tools +.. automodule:: diffpy.morph.morphpy :members: :undoc-members: :show-inheritance: @@ -60,10 +60,10 @@ diffpy.morph.morph_io module :undoc-members: :show-inheritance: -diffpy.morph.log module -^^^^^^^^^^^^^^^^^^^^^^^ +diffpy.morph.refine module +^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.morph.log +.. automodule:: diffpy.morph.refine :members: :undoc-members: :show-inheritance: @@ -75,3 +75,11 @@ diffpy.morph.morphapp module :members: :undoc-members: :show-inheritance: + +diffpy.morph.log module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.morph.log + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 98% rename from doc/source/conf.py rename to docs/source/conf.py index 9ac22a75..64a5c046 100644 --- a/doc/source/conf.py +++ b/docs/source/conf.py @@ -24,7 +24,8 @@ except Exception: fullversion = "No version found. The correct version will appear in the released version." # noqa: E501 -# Import modules referenced in documentation (resolves `WARNING: autodoc: failed to import module`) +# Import modules referenced in documentation +# (resolves `WARNING: autodoc: failed to import module`) autodoc_mock_imports = [ "diffpy.utils", ] diff --git a/doc/source/images/ex_tutorial_bar.png b/docs/source/images/ex_tutorial_bar.png similarity index 100% rename from doc/source/images/ex_tutorial_bar.png rename to docs/source/images/ex_tutorial_bar.png diff --git a/doc/source/images/ex_tutorial_temp.png b/docs/source/images/ex_tutorial_temp.png similarity index 100% rename from doc/source/images/ex_tutorial_temp.png rename to docs/source/images/ex_tutorial_temp.png diff --git a/doc/source/images/qs_tutorial_morphed.png b/docs/source/images/qs_tutorial_morphed.png similarity index 100% rename from doc/source/images/qs_tutorial_morphed.png rename to docs/source/images/qs_tutorial_morphed.png diff --git a/doc/source/images/qs_tutorial_scaled.png b/docs/source/images/qs_tutorial_scaled.png similarity index 100% rename from doc/source/images/qs_tutorial_scaled.png rename to docs/source/images/qs_tutorial_scaled.png diff --git a/doc/source/images/qs_tutorial_unmorphed.png b/docs/source/images/qs_tutorial_unmorphed.png similarity index 100% rename from doc/source/images/qs_tutorial_unmorphed.png rename to docs/source/images/qs_tutorial_unmorphed.png diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/license.rst b/docs/source/license.rst similarity index 100% rename from doc/source/license.rst rename to docs/source/license.rst diff --git a/doc/source/morphpy.rst b/docs/source/morphpy.rst similarity index 100% rename from doc/source/morphpy.rst rename to docs/source/morphpy.rst diff --git a/doc/source/quickstart.rst b/docs/source/quickstart.rst similarity index 100% rename from doc/source/quickstart.rst rename to docs/source/quickstart.rst diff --git a/doc/source/release.rst b/docs/source/release.rst similarity index 100% rename from doc/source/release.rst rename to docs/source/release.rst diff --git a/doc/source/tutorialfiles.rst b/docs/source/tutorialfiles.rst similarity index 100% rename from doc/source/tutorialfiles.rst rename to docs/source/tutorialfiles.rst diff --git a/doc/source/tutorials.rst b/docs/source/tutorials.rst similarity index 100% rename from doc/source/tutorials.rst rename to docs/source/tutorials.rst diff --git a/requirements/test.txt b/requirements/tests.txt similarity index 100% rename from requirements/test.txt rename to requirements/tests.txt