add new modules to docs

FahrplanDatenGarten · Jul 22, 2020 · b5ef08a · b5ef08a
1 parent a18d08c
commit b5ef08a
Show file tree

Hide file tree

Showing 39 changed files with 368 additions and 16 deletions.
diff --git a/docs/pyhafas.fptf.rst b/docs/pyhafas.fptf.rst
diff --git a/docs/pyhafas.profile.base.helper.format_products_filter.rst b/docs/pyhafas.profile.base.helper.format_products_filter.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.helper.format\_products\_filter module
+===========================================================
+
+.. automodule:: pyhafas.profile.base.helper.format_products_filter
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.helper.parse_date_time.rst b/docs/pyhafas.profile.base.helper.parse_date_time.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.helper.parse\_date\_time module
+====================================================
+
+.. automodule:: pyhafas.profile.base.helper.parse_date_time
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.helper.parse_leg.rst b/docs/pyhafas.profile.base.helper.parse_leg.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.helper.parse\_leg module
+=============================================
+
+.. automodule:: pyhafas.profile.base.helper.parse_leg
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.helper.parse_lid.rst b/docs/pyhafas.profile.base.helper.parse_lid.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.helper.parse\_lid module
+=============================================
+
+.. automodule:: pyhafas.profile.base.helper.parse_lid
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.helper.request.rst b/docs/pyhafas.profile.base.helper.request.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.helper.request module
+==========================================
+
+.. automodule:: pyhafas.profile.base.helper.request
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.helper.rst b/docs/pyhafas.profile.base.helper.rst
@@ -0,0 +1,22 @@
+pyhafas.profile.base.helper package
+===================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyhafas.profile.base.helper.format_products_filter
+   pyhafas.profile.base.helper.parse_date_time
+   pyhafas.profile.base.helper.parse_leg
+   pyhafas.profile.base.helper.parse_lid
+   pyhafas.profile.base.helper.request
+
+Module contents
+---------------
+
+.. automodule:: pyhafas.profile.base.helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.mappings.error_codes.rst b/docs/pyhafas.profile.base.mappings.error_codes.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.mappings.error\_codes module
+=================================================
+
+.. automodule:: pyhafas.profile.base.mappings.error_codes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.mappings.rst b/docs/pyhafas.profile.base.mappings.rst
@@ -0,0 +1,18 @@
+pyhafas.profile.base.mappings package
+=====================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyhafas.profile.base.mappings.error_codes
+
+Module contents
+---------------
+
+.. automodule:: pyhafas.profile.base.mappings
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.requests.journey.rst b/docs/pyhafas.profile.base.requests.journey.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.requests.journey module
+============================================
+
+.. automodule:: pyhafas.profile.base.requests.journey
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.requests.journeys.rst b/docs/pyhafas.profile.base.requests.journeys.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.requests.journeys module
+=============================================
+
+.. automodule:: pyhafas.profile.base.requests.journeys
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.requests.location.rst b/docs/pyhafas.profile.base.requests.location.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.requests.location module
+=============================================
+
+.. automodule:: pyhafas.profile.base.requests.location
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.requests.rst b/docs/pyhafas.profile.base.requests.rst
@@ -0,0 +1,22 @@
+pyhafas.profile.base.requests package
+=====================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyhafas.profile.base.requests.journey
+   pyhafas.profile.base.requests.journeys
+   pyhafas.profile.base.requests.location
+   pyhafas.profile.base.requests.station_board
+   pyhafas.profile.base.requests.trip
+
+Module contents
+---------------
+
+.. automodule:: pyhafas.profile.base.requests
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.requests.station_board.rst b/docs/pyhafas.profile.base.requests.station_board.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.requests.station\_board module
+===================================================
+
+.. automodule:: pyhafas.profile.base.requests.station_board
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.requests.trip.rst b/docs/pyhafas.profile.base.requests.trip.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.base.requests.trip module
+=========================================
+
+.. automodule:: pyhafas.profile.base.requests.trip
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.base.rst b/docs/pyhafas.profile.base.rst
@@ -1,5 +1,18 @@
-pyhafas.profile.base module
-===========================
+pyhafas.profile.base package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyhafas.profile.base.helper
+   pyhafas.profile.base.mappings
+   pyhafas.profile.base.requests
+
+Module contents
+---------------
 
 .. automodule:: pyhafas.profile.base
    :members:

diff --git a/docs/pyhafas.profile.db.rst b/docs/pyhafas.profile.db.rst
@@ -1,5 +1,8 @@
-pyhafas.profile.db module
-=========================
+pyhafas.profile.db package
+==========================
+
+Module contents
+---------------
 
 .. automodule:: pyhafas.profile.db
    :members:

diff --git a/docs/pyhafas.profile.interfaces.helper.format_products_filter.rst b/docs/pyhafas.profile.interfaces.helper.format_products_filter.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.helper.format\_products\_filter module
+=================================================================
+
+.. automodule:: pyhafas.profile.interfaces.helper.format_products_filter
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.helper.parse_date_time.rst b/docs/pyhafas.profile.interfaces.helper.parse_date_time.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.helper.parse\_date\_time module
+==========================================================
+
+.. automodule:: pyhafas.profile.interfaces.helper.parse_date_time
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.helper.parse_leg.rst b/docs/pyhafas.profile.interfaces.helper.parse_leg.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.helper.parse\_leg module
+===================================================
+
+.. automodule:: pyhafas.profile.interfaces.helper.parse_leg
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.helper.parse_lid.rst b/docs/pyhafas.profile.interfaces.helper.parse_lid.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.helper.parse\_lid module
+===================================================
+
+.. automodule:: pyhafas.profile.interfaces.helper.parse_lid
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.helper.request.rst b/docs/pyhafas.profile.interfaces.helper.request.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.helper.request module
+================================================
+
+.. automodule:: pyhafas.profile.interfaces.helper.request
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.helper.rst b/docs/pyhafas.profile.interfaces.helper.rst
@@ -0,0 +1,22 @@
+pyhafas.profile.interfaces.helper package
+=========================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyhafas.profile.interfaces.helper.format_products_filter
+   pyhafas.profile.interfaces.helper.parse_date_time
+   pyhafas.profile.interfaces.helper.parse_leg
+   pyhafas.profile.interfaces.helper.parse_lid
+   pyhafas.profile.interfaces.helper.request
+
+Module contents
+---------------
+
+.. automodule:: pyhafas.profile.interfaces.helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.mappings.error_codes.rst b/docs/pyhafas.profile.interfaces.mappings.error_codes.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.mappings.error\_codes module
+=======================================================
+
+.. automodule:: pyhafas.profile.interfaces.mappings.error_codes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.mappings.rst b/docs/pyhafas.profile.interfaces.mappings.rst
@@ -0,0 +1,18 @@
+pyhafas.profile.interfaces.mappings package
+===========================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyhafas.profile.interfaces.mappings.error_codes
+
+Module contents
+---------------
+
+.. automodule:: pyhafas.profile.interfaces.mappings
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.requests.journey.rst b/docs/pyhafas.profile.interfaces.requests.journey.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.requests.journey module
+==================================================
+
+.. automodule:: pyhafas.profile.interfaces.requests.journey
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.requests.journeys.rst b/docs/pyhafas.profile.interfaces.requests.journeys.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.requests.journeys module
+===================================================
+
+.. automodule:: pyhafas.profile.interfaces.requests.journeys
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.requests.location.rst b/docs/pyhafas.profile.interfaces.requests.location.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.requests.location module
+===================================================
+
+.. automodule:: pyhafas.profile.interfaces.requests.location
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.requests.rst b/docs/pyhafas.profile.interfaces.requests.rst
@@ -0,0 +1,22 @@
+pyhafas.profile.interfaces.requests package
+===========================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyhafas.profile.interfaces.requests.journey
+   pyhafas.profile.interfaces.requests.journeys
+   pyhafas.profile.interfaces.requests.location
+   pyhafas.profile.interfaces.requests.station_board
+   pyhafas.profile.interfaces.requests.trip
+
+Module contents
+---------------
+
+.. automodule:: pyhafas.profile.interfaces.requests
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.requests.station_board.rst b/docs/pyhafas.profile.interfaces.requests.station_board.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.requests.station\_board module
+=========================================================
+
+.. automodule:: pyhafas.profile.interfaces.requests.station_board
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.requests.trip.rst b/docs/pyhafas.profile.interfaces.requests.trip.rst
@@ -0,0 +1,7 @@
+pyhafas.profile.interfaces.requests.trip module
+===============================================
+
+.. automodule:: pyhafas.profile.interfaces.requests.trip
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.interfaces.rst b/docs/pyhafas.profile.interfaces.rst
@@ -0,0 +1,20 @@
+pyhafas.profile.interfaces package
+==================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pyhafas.profile.interfaces.helper
+   pyhafas.profile.interfaces.mappings
+   pyhafas.profile.interfaces.requests
+
+Module contents
+---------------
+
+.. automodule:: pyhafas.profile.interfaces
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/pyhafas.profile.rst b/docs/pyhafas.profile.rst
@@ -1,14 +1,15 @@
 pyhafas.profile package
 =======================
 
-Submodules
-----------
+Subpackages
+-----------
 
 .. toctree::
    :maxdepth: 4
 
    pyhafas.profile.base
    pyhafas.profile.db
+   pyhafas.profile.interfaces
    pyhafas.profile.vsn
 
 Module contents

diff --git a/docs/pyhafas.profile.vsn.rst b/docs/pyhafas.profile.vsn.rst
@@ -1,5 +1,8 @@
-pyhafas.profile.vsn module
-==========================
+pyhafas.profile.vsn package
+===========================
+
+Module contents
+---------------
 
 .. automodule:: pyhafas.profile.vsn
    :members: