GSOREB-172 #time 1h add documentation to main models, improve sphinx …

…build, cant fix cross attribute warnings due to still open bug in sphinx: sphinx-doc/sphinx#2549
openoereb · May 10, 2017 · 62e254a · 62e254a
1 parent 0fdaf83
commit 62e254a
Show file tree

Hide file tree

Showing 20 changed files with 317 additions and 317 deletions.
diff --git a/doc/source/api.rst.mako b/doc/source/api.rst.mako
@@ -29,16 +29,16 @@ for module in modules:
 %>
 
 %for module in modules:
-    Module: ${module}
-    --------${re.sub('.', '-', module)}
+Module: ${module}
+--------${re.sub('.', '-', module)}
 
-    .. automodule:: ${module}
-       :members:
+.. automodule:: ${module}
+   :members:
 
-    %for cls in classes[module]:
+%for cls in classes[module]:
 
-    .. autoclass:: ${module}.${cls}
-       :members:
+.. autoclass:: ${module}.${cls}
+   :members:
 
-    %endfor
+%endfor
 %endfor
diff --git a/pyramid_oereb/standard/models/airports_building_lines.py b/pyramid_oereb/standard/models/airports_building_lines.py
@@ -99,7 +99,7 @@ class ReferenceDefinition(Base):  # TODO: Check translation
     :var office_id: The foreign key constraint which the definition is related to.
     :vartype office_id: int
     :var office: The dedicated relation to the office instance from database.
-    :vartype responsible_office: Office
+    :vartype responsible_office: pyramid_oereb.standard.models.airports_building_lines.Office
     """
     __table_args__ = {'schema': 'airports_building_lines'}
     __tablename__ = 'reference_definition'
@@ -172,7 +172,7 @@ class Document(DocumentBase):
     :var office_id: The foreign key to the office which is in charge for this document.
     :vartype office_id: int
     :var responsible_office: The dedicated relation to the office instance from database.
-    :vartype responsible_office: Office
+    :vartype responsible_office: pyramid_oereb.standard.models.airports_building_lines.Office
     """
     __table_args__ = {'schema': 'airports_building_lines'}
     __tablename__ = 'document'
@@ -215,7 +215,7 @@ class Article(DocumentBase):
     :var document_id: The foreign key to the document this article is taken from.
     :vartype document_id: int
     :var document: The dedicated relation to the document instance from database.
-    :vartype document_id: Document
+    :vartype document_id: pyramid_oereb.standard.models.airports_building_lines.Document
     """
     __table_args__ = {'schema': 'airports_building_lines'}
     __tablename__ = 'article'
@@ -315,7 +315,7 @@ class LegendEntry(Base):
     :var view_service_id: The foreign key to the view service this legend entry is related to.
     :vartype view_service_id: int
     :var view_service: The dedicated relation to the view service instance from database.
-    :vartype view_service: ViewService
+    :vartype view_service: pyramid_oereb.standard.models.airports_building_lines.ViewService
     """
     __table_args__ = {'schema': 'airports_building_lines'}
     __tablename__ = 'legend_entry'
@@ -370,11 +370,11 @@ class PublicLawRestriction(Base):
     :var view_service_id: The foreign key to the view service this public law restriction is related to.
     :vartype view_service_id: int
     :var view_service: The dedicated relation to the view service instance from database.
-    :vartype view_service: ViewService
+    :vartype view_service: pyramid_oereb.standard.models.airports_building_lines.ViewService
     :var office_id: The foreign key to the office which is responsible to this public law restriction.
     :vartype office_id: int
     :var responsible_office: The dedicated relation to the office instance from database.
-    :vartype responsible_office: Office
+    :vartype responsible_office: pyramid_oereb.standard.models.airports_building_lines.Office
     """
     __table_args__ = {'schema': 'airports_building_lines'}
     __tablename__ = 'public_law_restriction'
@@ -426,17 +426,17 @@ class Geometry(Base):
         docs dependent on the configured type.
 
         This concrete one is POLYGON
-    :vartype geom: GeoAlchemyGeometry
+    :vartype geom: geoalchemy2.types.Geometry
     :var public_law_restriction_id: The foreign key to the public law restriction this geometry is
         related to.
     :vartype public_law_restriction_id: int
     :var public_law_restriction: The dedicated relation to the public law restriction instance from
         database.
-    :vartype public_law_restriction: PublicLawRestriction
+    :vartype public_law_restriction: pyramid_oereb.standard.models.airports_building_lines.PublicLawRestriction
     :var office_id: The foreign key to the office which is responsible to this public law restriction.
     :vartype office_id: int
     :var responsible_office: The dedicated relation to the office instance from database.
-    :vartype responsible_office: Office
+    :vartype responsible_office: pyramid_oereb.standard.models.airports_building_lines.Office
     """
     __table_args__ = {'schema': 'airports_building_lines'}
     __tablename__ = 'geometry'
@@ -478,10 +478,10 @@ class PublicLawRestrictionBase(Base):
     :vartype public_law_restriction_base_id: int
     :var plr: The dedicated relation to the public law restriction (which bases on) instance from
         database.
-    :vartype plr: PublicLawRestriction
+    :vartype plr: pyramid_oereb.standard.models.airports_building_lines.PublicLawRestriction
     :var base: The dedicated relation to the public law restriction (which is the base) instance from
         database.
-    :vartype base: PublicLawRestriction
+    :vartype base: pyramid_oereb.standard.models.airports_building_lines.PublicLawRestriction
     """
     __tablename__ = 'public_law_restriction_base'
     __table_args__ = {'schema': 'airports_building_lines'}
@@ -523,10 +523,10 @@ class PublicLawRestrictionRefinement(Base):
     :vartype public_law_restriction_refinement_id: int
     :var plr: The dedicated relation to the public law restriction (which refines) instance from
         database.
-    :vartype plr: PublicLawRestriction
+    :vartype plr: pyramid_oereb.standard.models.airports_building_lines.PublicLawRestriction
     :var base: The dedicated relation to the public law restriction (which is refined) instance from
         database.
-    :vartype base: PublicLawRestriction
+    :vartype base: pyramid_oereb.standard.models.airports_building_lines.PublicLawRestriction
     """
     __tablename__ = 'public_law_restriction_refinement'
     __table_args__ = {'schema': 'airports_building_lines'}
@@ -565,9 +565,9 @@ class PublicLawRestrictionDocument(Base):
     :var document_id: The foreign key to the document which has relation to the public law restriction.
     :vartype document_id: int
     :var plr: The dedicated relation to the public law restriction instance from database.
-    :vartype plr: PublicLawRestriction
+    :vartype plr: pyramid_oereb.standard.models.airports_building_lines.PublicLawRestriction
     :var document: The dedicated relation to the document instance from database.
-    :vartype document: DocumentBase
+    :vartype document: pyramid_oereb.standard.models.airports_building_lines.DocumentBase
     """
     __tablename__ = 'public_law_restriction_document'
     __table_args__ = {'schema': 'airports_building_lines'}
@@ -605,10 +605,10 @@ class DocumentReference(Base):
     :var reference_document_id: The foreign key to the document which is referenced.
     :vartype reference_document_id: int
     :var document: The dedicated relation to the document (which references) instance from database.
-    :vartype document: Document
+    :vartype document: pyramid_oereb.standard.models.airports_building_lines.Document
     :var referenced_document: The dedicated relation to the document (which is referenced) instance from
         database.
-    :vartype referenced_document: Document
+    :vartype referenced_document: pyramid_oereb.standard.models.airports_building_lines.Document
     :var article_numbers: A colon of article numbers which clarify the reference. This is a string
         separated by '|'.
     :vartype article_numbers: str

diff --git a/pyramid_oereb/standard/models/airports_project_planning_zones.py b/pyramid_oereb/standard/models/airports_project_planning_zones.py
@@ -99,7 +99,7 @@ class ReferenceDefinition(Base):  # TODO: Check translation
     :var office_id: The foreign key constraint which the definition is related to.
     :vartype office_id: int
     :var office: The dedicated relation to the office instance from database.
-    :vartype responsible_office: Office
+    :vartype responsible_office: pyramid_oereb.standard.models.airports_project_planning_zones.Office
     """
     __table_args__ = {'schema': 'airports_project_planning_zones'}
     __tablename__ = 'reference_definition'
@@ -172,7 +172,7 @@ class Document(DocumentBase):
     :var office_id: The foreign key to the office which is in charge for this document.
     :vartype office_id: int
     :var responsible_office: The dedicated relation to the office instance from database.
-    :vartype responsible_office: Office
+    :vartype responsible_office: pyramid_oereb.standard.models.airports_project_planning_zones.Office
     """
     __table_args__ = {'schema': 'airports_project_planning_zones'}
     __tablename__ = 'document'
@@ -215,7 +215,7 @@ class Article(DocumentBase):
     :var document_id: The foreign key to the document this article is taken from.
     :vartype document_id: int
     :var document: The dedicated relation to the document instance from database.
-    :vartype document_id: Document
+    :vartype document_id: pyramid_oereb.standard.models.airports_project_planning_zones.Document
     """
     __table_args__ = {'schema': 'airports_project_planning_zones'}
     __tablename__ = 'article'
@@ -315,7 +315,7 @@ class LegendEntry(Base):
     :var view_service_id: The foreign key to the view service this legend entry is related to.
     :vartype view_service_id: int
     :var view_service: The dedicated relation to the view service instance from database.
-    :vartype view_service: ViewService
+    :vartype view_service: pyramid_oereb.standard.models.airports_project_planning_zones.ViewService
     """
     __table_args__ = {'schema': 'airports_project_planning_zones'}
     __tablename__ = 'legend_entry'
@@ -370,11 +370,11 @@ class PublicLawRestriction(Base):
     :var view_service_id: The foreign key to the view service this public law restriction is related to.
     :vartype view_service_id: int
     :var view_service: The dedicated relation to the view service instance from database.
-    :vartype view_service: ViewService
+    :vartype view_service: pyramid_oereb.standard.models.airports_project_planning_zones.ViewService
     :var office_id: The foreign key to the office which is responsible to this public law restriction.
     :vartype office_id: int
     :var responsible_office: The dedicated relation to the office instance from database.
-    :vartype responsible_office: Office
+    :vartype responsible_office: pyramid_oereb.standard.models.airports_project_planning_zones.Office
     """
     __table_args__ = {'schema': 'airports_project_planning_zones'}
     __tablename__ = 'public_law_restriction'
@@ -426,17 +426,17 @@ class Geometry(Base):
         docs dependent on the configured type.
 
         This concrete one is POLYGON
-    :vartype geom: GeoAlchemyGeometry
+    :vartype geom: geoalchemy2.types.Geometry
     :var public_law_restriction_id: The foreign key to the public law restriction this geometry is
         related to.
     :vartype public_law_restriction_id: int
     :var public_law_restriction: The dedicated relation to the public law restriction instance from
         database.
-    :vartype public_law_restriction: PublicLawRestriction
+    :vartype public_law_restriction: pyramid_oereb.standard.models.airports_project_planning_zones.PublicLawRestriction
     :var office_id: The foreign key to the office which is responsible to this public law restriction.
     :vartype office_id: int
     :var responsible_office: The dedicated relation to the office instance from database.
-    :vartype responsible_office: Office
+    :vartype responsible_office: pyramid_oereb.standard.models.airports_project_planning_zones.Office
     """
     __table_args__ = {'schema': 'airports_project_planning_zones'}
     __tablename__ = 'geometry'
@@ -478,10 +478,10 @@ class PublicLawRestrictionBase(Base):
     :vartype public_law_restriction_base_id: int
     :var plr: The dedicated relation to the public law restriction (which bases on) instance from
         database.
-    :vartype plr: PublicLawRestriction
+    :vartype plr: pyramid_oereb.standard.models.airports_project_planning_zones.PublicLawRestriction
     :var base: The dedicated relation to the public law restriction (which is the base) instance from
         database.
-    :vartype base: PublicLawRestriction
+    :vartype base: pyramid_oereb.standard.models.airports_project_planning_zones.PublicLawRestriction
     """
     __tablename__ = 'public_law_restriction_base'
     __table_args__ = {'schema': 'airports_project_planning_zones'}
@@ -523,10 +523,10 @@ class PublicLawRestrictionRefinement(Base):
     :vartype public_law_restriction_refinement_id: int
     :var plr: The dedicated relation to the public law restriction (which refines) instance from
         database.
-    :vartype plr: PublicLawRestriction
+    :vartype plr: pyramid_oereb.standard.models.airports_project_planning_zones.PublicLawRestriction
     :var base: The dedicated relation to the public law restriction (which is refined) instance from
         database.
-    :vartype base: PublicLawRestriction
+    :vartype base: pyramid_oereb.standard.models.airports_project_planning_zones.PublicLawRestriction
     """
     __tablename__ = 'public_law_restriction_refinement'
     __table_args__ = {'schema': 'airports_project_planning_zones'}
@@ -565,9 +565,9 @@ class PublicLawRestrictionDocument(Base):
     :var document_id: The foreign key to the document which has relation to the public law restriction.
     :vartype document_id: int
     :var plr: The dedicated relation to the public law restriction instance from database.
-    :vartype plr: PublicLawRestriction
+    :vartype plr: pyramid_oereb.standard.models.airports_project_planning_zones.PublicLawRestriction
     :var document: The dedicated relation to the document instance from database.
-    :vartype document: DocumentBase
+    :vartype document: pyramid_oereb.standard.models.airports_project_planning_zones.DocumentBase
     """
     __tablename__ = 'public_law_restriction_document'
     __table_args__ = {'schema': 'airports_project_planning_zones'}
@@ -605,10 +605,10 @@ class DocumentReference(Base):
     :var reference_document_id: The foreign key to the document which is referenced.
     :vartype reference_document_id: int
     :var document: The dedicated relation to the document (which references) instance from database.
-    :vartype document: Document
+    :vartype document: pyramid_oereb.standard.models.airports_project_planning_zones.Document
     :var referenced_document: The dedicated relation to the document (which is referenced) instance from
         database.
-    :vartype referenced_document: Document
+    :vartype referenced_document: pyramid_oereb.standard.models.airports_project_planning_zones.Document
     :var article_numbers: A colon of article numbers which clarify the reference. This is a string
         separated by '|'.
     :vartype article_numbers: str