correct cerc_persistence autodoc

source/conf.py

@@ -42,7 +42,7 @@ extensions = [
    'sphinx.ext.autodoc',
    'cerc_documenter'
 ]
-autodoc_mock_imports = ["pyproj", "numpy", "trimesh", "Node", "Edge", "pandas", "typing", "xmltodict", "geomeppy",
+autodoc_mock_imports = ["pyproj", "sqlalchemy", "hub", "numpy", "trimesh", "Node", "Edge", "pandas", "typing", "xmltodict", "geomeppy",
                         "parseidf", "rhino3dm", "pyecore", "EPackage", "pyecore.ecore", "geopandas", "shapely",
                         "catalog_factories.greenery.greenery_catalog"
                         ]

source/index.rst

@@ -23,30 +23,25 @@ CERC PERSISTENCE' reference manual
 Authors
 *************************
 
+* Peter Yefi
 * Guillermo Gutierrez Morote
-* Pilar Monsalvete Alvarez de Uribarri
 
 Contributors
 *************************
 
-* Seyedehrabeeh Hosseinihaghighi
+* Ruben Sanchez
-* Milad Aghamohamadnia
-* Peter Yefi
-* Koa Wells
-* Sanam Dabirian
-* Soroush Samareh Abolhassani
 
 About the PERSISTENCE
 *************************
 
-This document contains the essential documentation for the CERC PERSISTENCE, a set of classes, factories, and helpers that simplifies the research at urban scale in multiples domains; these components are designed around three central axes, **extensibility**, **code clarity** and **consistency** as we intend to allow domain experts to perform urban scale simulations with multiple programs and enrich the city from several data sources.
+This document contains the essential documentation for the cerc persistence package, a set of classes, that allows the permanent storage of a cec_hub city.
-PERSISTENCE is composed of four main components: **repositories** and **models**.
+cerc persistence package is composed of two main components: **repositories** and **models**.
 
 Folder structure
 ******************
 
 .. image:: ./cerc_persistence.png
-   :width: 200
+   :width: 400
 
 Model Classes
 ****************************
@@ -55,75 +50,59 @@ Application
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.models.application.Application
    :members:
-   :private-members:
 
 City
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.models.city.City
    :members:
-   :private-members:
 
 CityObject
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.models.city_object.CityObject
    :members:
-   :private-members:
 
 
 SimulationResults
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.models.simulation_results.SimulationResults
    :members:
-   :private-members:
 
 
 User
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.models.user.User
    :members:
-   :private-members:
 
 
-UserRoles
-^^^^^^^^^^^^^^^^^^^^^^
-.. autocercclass:: cerc_persistence.models.user.UserRoles
-   :members:
-   :private-members:
-
 Repository Classes
 ****************************
 
 Application
 ^^^^^^^^^^^^^^^^^^^^^^
-.. autocercclass:: cerc_persistence.models.application.Application
+.. autocercclass:: cerc_persistence.repositories.application.Application
    :members:
-   :private-members:
 
 City
 ^^^^^^^^^^^^^^^^^^^^^^
-.. autocercclass:: cerc_persistence.models.city.City
+.. autocercclass:: cerc_persistence.repositories.city.City
    :members:
-   :private-members:
 
 CityObject
 ^^^^^^^^^^^^^^^^^^^^^^
-.. autocercclass:: cerc_persistence.models.city_object.CityObject
+.. autocercclass:: cerc_persistence.repositories.city_object.CityObject
    :members:
-   :private-members:
 
 
 SimulationResults
 ^^^^^^^^^^^^^^^^^^^^^^
-.. autocercclass:: cerc_persistence.models.simulation_results.SimulationResults
+.. autocercclass:: cerc_persistence.repositories.simulation_results.SimulationResults
    :members:
-   :private-members:
 
 
 User
 ^^^^^^^^^^^^^^^^^^^^^^
-.. autocercclass:: cerc_persistence.models.user.User
+.. autocercclass:: cerc_persistence.repositories.user.User
    :members:
-   :private-members:
 
 Classes
 ****************************
@@ -132,25 +111,21 @@ Configuration
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.configuration.Configuration
    :members:
-   :private-members:
 
 DB Control
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.db_control.DBControl
    :members:
-   :private-members:
 
 DB Setup
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.db_setup.DBSetup
    :members:
-   :private-members:
 
 Repository
 ^^^^^^^^^^^^^^^^^^^^^^
 .. autocercclass:: cerc_persistence.repository.Repository
    :members:
-   :private-members:
 
 Additional Files
 ====================