FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: fix documentation rendered properly by stevenhua0320 · Pull Request #192 · diffpy/diffpy.structure · GitHub

Repository navigation

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .py  (1) .rst  (4) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
8 changes: 8 additions & 0 deletions docs/source/api/diffpy.structure.apps.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -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:
8 changes: 8 additions & 0 deletions docs/source/api/diffpy.structure.parsers.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
14 changes: 10 additions & 4 deletions docs/source/api/diffpy.structure.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
:tocdepth: -1

|title|
=======

.. |title| replace:: diffpy.structure package
diffpy.structure package
========================

.. automodule:: diffpy.structure
:members:
Expand All @@ -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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 23 additions & 0 deletions news/documentation-fix.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* No news added: documentation fix for diffpy.structure

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading

Back | FazBrowse Home | New Git URL