Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
larsbuntemeyer committed Feb 16, 2021
1 parent 8a1b475 commit 172aa49
Show file tree
Hide file tree
Showing 6 changed files with 181 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/pyremo.physics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
pyremo.physics package
======================

Submodules
----------

pyremo.physics.constants module
-------------------------------

.. automodule:: pyremo.physics.constants
:members:
:undoc-members:
:show-inheritance:

pyremo.physics.physics module
-----------------------------

.. automodule:: pyremo.physics.physics
:members:
:undoc-members:
:show-inheritance:

pyremo.physics.units module
---------------------------

.. automodule:: pyremo.physics.units
:members:
:undoc-members:
:show-inheritance:


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

.. automodule:: pyremo.physics
:members:
:undoc-members:
:show-inheritance:
94 changes: 94 additions & 0 deletions docs/pyremo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
pyremo package
==============

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

.. toctree::

pyremo.physics
pyremo.tables

Submodules
----------

pyremo.cli module
-----------------

.. automodule:: pyremo.cli
:members:
:undoc-members:
:show-inheritance:

pyremo.codes module
-------------------

.. automodule:: pyremo.codes
:members:
:undoc-members:
:show-inheritance:

pyremo.domain module
--------------------

.. automodule:: pyremo.domain
:members:
:undoc-members:
:show-inheritance:

pyremo.example\_google module
-----------------------------

.. automodule:: pyremo.example_google
:members:
:undoc-members:
:show-inheritance:

pyremo.example\_numpy module
----------------------------

.. automodule:: pyremo.example_numpy
:members:
:undoc-members:
:show-inheritance:

pyremo.pyremo module
--------------------

.. automodule:: pyremo.pyremo
:members:
:undoc-members:
:show-inheritance:

pyremo.remo\_ds module
----------------------

.. automodule:: pyremo.remo_ds
:members:
:undoc-members:
:show-inheritance:

pyremo.variable module
----------------------

.. automodule:: pyremo.variable
:members:
:undoc-members:
:show-inheritance:

pyremo.vc module
----------------

.. automodule:: pyremo.vc
:members:
:undoc-members:
:show-inheritance:


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

.. automodule:: pyremo
:members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/pyremo.tables.code_list.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
pyremo.tables.code\_list package
================================

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

.. automodule:: pyremo.tables.code_list
:members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/pyremo.tables.domains.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
pyremo.tables.domains package
=============================

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

.. automodule:: pyremo.tables.domains
:members:
:undoc-members:
:show-inheritance:
19 changes: 19 additions & 0 deletions docs/pyremo.tables.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
pyremo.tables package
=====================

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

.. toctree::

pyremo.tables.code_list
pyremo.tables.domains
pyremo.tables.vc

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

.. automodule:: pyremo.tables
:members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/pyremo.tables.vc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
pyremo.tables.vc package
========================

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

.. automodule:: pyremo.tables.vc
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 172aa49

Please sign in to comment.