From 87f8b1269ab4d55a0f646f2ada4c58827f945808 Mon Sep 17 00:00:00 2001 From: stevenhua0320 Date: Sat, 28 Mar 2026 22:40:46 -0400 Subject: [PATCH] fix: fix documentation rendered properly --- docs/source/api/diffpy.structure.apps.rst | 8 +++++++ docs/source/api/diffpy.structure.parsers.rst | 8 +++++++ docs/source/api/diffpy.structure.rst | 14 ++++++++---- docs/source/conf.py | 2 +- news/documentation-fix.rst | 23 ++++++++++++++++++++ 5 files changed, 50 insertions(+), 5 deletions(-) create mode 100644 news/documentation-fix.rst diff --git a/docs/source/api/diffpy.structure.apps.rst b/docs/source/api/diffpy.structure.apps.rst index 8b91adf5..3986ab73 100644 --- a/docs/source/api/diffpy.structure.apps.rst +++ b/docs/source/api/diffpy.structure.apps.rst @@ -26,3 +26,11 @@ diffpy.structure.apps.anyeye module :members: :undoc-members: :show-inheritance: + +diffpy.structure.apps.vesta_viewer module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.structure.apps.vesta_viewer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/diffpy.structure.parsers.rst b/docs/source/api/diffpy.structure.parsers.rst index 74a27bcb..8a5e9476 100644 --- a/docs/source/api/diffpy.structure.parsers.rst +++ b/docs/source/api/diffpy.structure.parsers.rst @@ -83,6 +83,14 @@ diffpy.structure.parsers.p_discus module :undoc-members: :show-inheritance: +diffpy.structure.parsers.p_vesta module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.structure.parsers.p_vesta + :members: + :undoc-members: + :show-inheritance: + diffpy.structure.parsers.p_xyz module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/api/diffpy.structure.rst b/docs/source/api/diffpy.structure.rst index d6ffb2ad..7807ec06 100644 --- a/docs/source/api/diffpy.structure.rst +++ b/docs/source/api/diffpy.structure.rst @@ -1,9 +1,7 @@ :tocdepth: -1 -|title| -======= - -.. |title| replace:: diffpy.structure package +diffpy.structure package +======================== .. automodule:: diffpy.structure :members: @@ -23,6 +21,14 @@ Subpackages Submodules ---------- +diffpy.structure.structure_app module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.structure.structure_app + :members: + :undoc-members: + :show-inheritance: + diffpy.structure.spacegroups module ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/conf.py b/docs/source/conf.py index 960f8fbb..e3c1fd99 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -23,7 +23,7 @@ fullversion = version("diffpy.structure") except Exception: fullversion = "No version found. The correct version will appear in the released version." # noqa: E501 - +autodoc_mock_imports = ["diffpy.utils"] # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use Path().resolve() to make it absolute, like shown here. # noqa: E501 diff --git a/news/documentation-fix.rst b/news/documentation-fix.rst new file mode 100644 index 00000000..30fe87e3 --- /dev/null +++ b/news/documentation-fix.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: documentation fix for diffpy.structure + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*