Skip to content

Commit 87f8b12

Browse files
committed
fix: fix documentation rendered properly
1 parent 41c51ac commit 87f8b12

File tree

5 files changed

+50
-5
lines changed

5 files changed

+50
-5
lines changed

docs/source/api/diffpy.structure.apps.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,11 @@ diffpy.structure.apps.anyeye module
2626
:members:
2727
:undoc-members:
2828
:show-inheritance:
29+
30+
diffpy.structure.apps.vesta_viewer module
31+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.structure.apps.vesta_viewer
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

docs/source/api/diffpy.structure.parsers.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,14 @@ diffpy.structure.parsers.p_discus module
8383
:undoc-members:
8484
:show-inheritance:
8585

86+
diffpy.structure.parsers.p_vesta module
87+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88+
89+
.. automodule:: diffpy.structure.parsers.p_vesta
90+
:members:
91+
:undoc-members:
92+
:show-inheritance:
93+
8694
diffpy.structure.parsers.p_xyz module
8795
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8896

docs/source/api/diffpy.structure.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
:tocdepth: -1
22

3-
|title|
4-
=======
5-
6-
.. |title| replace:: diffpy.structure package
3+
diffpy.structure package
4+
========================
75

86
.. automodule:: diffpy.structure
97
:members:
@@ -23,6 +21,14 @@ Subpackages
2321
Submodules
2422
----------
2523

24+
diffpy.structure.structure_app module
25+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26+
27+
.. automodule:: diffpy.structure.structure_app
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
2632
diffpy.structure.spacegroups module
2733
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2834

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
fullversion = version("diffpy.structure")
2424
except Exception:
2525
fullversion = "No version found. The correct version will appear in the released version." # noqa: E501
26-
26+
autodoc_mock_imports = ["diffpy.utils"]
2727
# If extensions (or modules to document with autodoc) are in another directory,
2828
# add these directories to sys.path here. If the directory is relative to the
2929
# documentation root, use Path().resolve() to make it absolute, like shown here. # noqa: E501

news/documentation-fix.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* No news added: documentation fix for diffpy.structure
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)