Skip to content

Commit

Permalink
updated sphinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drewschaub committed Dec 30, 2024
1 parent 17b144e commit 096366b
Show file tree
Hide file tree
Showing 8 changed files with 192 additions and 5 deletions.
7 changes: 2 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,11 @@ Welcome to Protein Design Tools's documentation!
:maxdepth: 2
:caption: Contents:

core/index
alignment/index
io/index
utils/index
modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`search`
7 changes: 7 additions & 0 deletions docs/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
protein_design_tools
====================

.. toctree::
:maxdepth: 4

protein_design_tools
21 changes: 21 additions & 0 deletions docs/protein_design_tools.alignment.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
protein\_design\_tools.alignment package
========================================

Submodules
----------

protein\_design\_tools.alignment.superpose module
-------------------------------------------------

.. automodule:: protein_design_tools.alignment.superpose
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: protein_design_tools.alignment
:members:
:undoc-members:
:show-inheritance:
45 changes: 45 additions & 0 deletions docs/protein_design_tools.core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
protein\_design\_tools.core package
===================================

Submodules
----------

protein\_design\_tools.core.atom module
---------------------------------------

.. automodule:: protein_design_tools.core.atom
:members:
:undoc-members:
:show-inheritance:

protein\_design\_tools.core.chain module
----------------------------------------

.. automodule:: protein_design_tools.core.chain
:members:
:undoc-members:
:show-inheritance:

protein\_design\_tools.core.protein\_structure module
-----------------------------------------------------

.. automodule:: protein_design_tools.core.protein_structure
:members:
:undoc-members:
:show-inheritance:

protein\_design\_tools.core.residue module
------------------------------------------

.. automodule:: protein_design_tools.core.residue
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: protein_design_tools.core
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions docs/protein_design_tools.io.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
protein\_design\_tools.io package
=================================

Submodules
----------

protein\_design\_tools.io.pdb module
------------------------------------

.. automodule:: protein_design_tools.io.pdb
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: protein_design_tools.io
:members:
:undoc-members:
:show-inheritance:
45 changes: 45 additions & 0 deletions docs/protein_design_tools.metrics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
protein\_design\_tools.metrics package
======================================

Submodules
----------

protein\_design\_tools.metrics.gdt module
-----------------------------------------

.. automodule:: protein_design_tools.metrics.gdt
:members:
:undoc-members:
:show-inheritance:

protein\_design\_tools.metrics.lddt module
------------------------------------------

.. automodule:: protein_design_tools.metrics.lddt
:members:
:undoc-members:
:show-inheritance:

protein\_design\_tools.metrics.rmsd module
------------------------------------------

.. automodule:: protein_design_tools.metrics.rmsd
:members:
:undoc-members:
:show-inheritance:

protein\_design\_tools.metrics.tmscore module
---------------------------------------------

.. automodule:: protein_design_tools.metrics.tmscore
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: protein_design_tools.metrics
:members:
:undoc-members:
:show-inheritance:
22 changes: 22 additions & 0 deletions docs/protein_design_tools.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
protein\_design\_tools package
==============================

Subpackages
-----------

.. toctree::
:maxdepth: 4

protein_design_tools.alignment
protein_design_tools.core
protein_design_tools.io
protein_design_tools.metrics
protein_design_tools.utils

Module contents
---------------

.. automodule:: protein_design_tools
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions docs/protein_design_tools.utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
protein\_design\_tools.utils package
====================================

Submodules
----------

protein\_design\_tools.utils.analysis module
--------------------------------------------

.. automodule:: protein_design_tools.utils.analysis
:members:
:undoc-members:
:show-inheritance:

protein\_design\_tools.utils.helpers module
-------------------------------------------

.. automodule:: protein_design_tools.utils.helpers
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: protein_design_tools.utils
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 096366b

Please sign in to comment.