Docs

doc/Makefile

@@ -151,3 +151,8 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo
+	@echo "Coverage test finished. The results are in $(BUILDDIR)/coverage."

doc/source/coverage.rst

+
+Objets non documentés
+=====================
+
+Cette page liste les objets non documentés.
+
+.. include:: ../build/coverage/python.txt
+   :start-line: 2
+

doc/source/gestion/config/mails/demenagement.rst

-demenagement -- Template de mail pour le déménagement
-=====================================================
-
-.. automodule:: gestion.config.mails.demenagement
-   :members:
-

doc/source/gestion/gen_confs/firewall4.rst

-
-gen_confs.firewall4 -- Le pare-feu ipv4
-=======================================
-
-.. automodule:: gestion.gen_confs.firewall4
-   :members:
-   :special-members:

doc/source/gestion/gen_confs/firewall4/base.rst

+
+base -- Le pare-feu ipv4 de base
+================================
+
+.. automodule:: gestion.gen_confs.firewall4.base
+   :members:
+   :special-members:

doc/source/gestion/gen_confs/firewall4/firewall4.rst

+
+firewall4 -- Le pare-feu ipv4
+=============================
+
+.. automodule:: gestion.gen_confs.firewall4.firewall4
+   :members:
+   :special-members:

doc/source/gestion/gen_confs/firewall4/index.rst

+firewall4 -- Le pare-feu ipv4
+==========================================
+
+Table des matières :
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   
+   *

doc/source/gestion/gen_confs/firewall4/komaz.rst

+
+komaz -- Le pare-feu ipv4 de komaz
+==================================
+
+.. automodule:: gestion.gen_confs.firewall4.komaz
+   :members:
+   :special-members:

doc/source/gestion/gen_confs/firewall4/routeur.rst

+
+routeur -- Le pare-feu ipv4 de routeur
+======================================
+
+.. automodule:: gestion.gen_confs.firewall4.routeur
+   :members:
+   :special-members:

doc/source/gestion/gen_confs/firewall4/utils.rst

+
+utils -- Le pare-feu ipv4, les fonctions de manipulation
+========================================================
+
+.. automodule:: gestion.gen_confs.firewall4.utils
+   :members:
+   :special-members:

doc/source/gestion/gen_confs/firewall4/zamok.rst

+
+zamok -- Le pare-feu ipv4 de zamok
+==================================
+
+.. automodule:: gestion.gen_confs.firewall4.zamok
+   :members:
+   :special-members:

doc/source/gestion/gen_confs/index.rst

@@ -7,4 +7,6 @@ Table des matières :
    :maxdepth: 2
    :glob:
    
+   firewall4/index
+
    *

doc/source/gestion/gest_crans_lc.rst

+GestCrans -- Gestion des machines et adhérents du crans, version lc_ldap
+========================================================================
+
+.. automodule:: gestion.gest_crans_lc
+   :members:
+   :private-members:
+   :special-members:
+   :show-inheritance:
+

doc/source/gestion/index.rst

@@ -8,3 +8,4 @@ Table des matières :
    
    config/index
    gen_confs/index
+   gest_crans_lc

doc/source/index.rst

@@ -14,6 +14,8 @@ Table des matières :
    gestion/index
    impression/index
 
+   others
+
 Indices and tables
 ==================
 

doc/source/others.rst

+
+Annexes
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   coverage
+.. var/coverage
+

gestion/gen_confs/firewall4/komaz.py

@@ -7,7 +7,7 @@ from utils import pretty_print, OK, anim
 from base import dev
 
 class firewall(base.firewall_routeur):
-
+    """Pare-feu du serveur komaz, routeur principal de l'association"""
     def __init__(self):
         super(self.__class__, self).__init__()
 
@@ -42,6 +42,7 @@ class firewall(base.firewall_routeur):
         })
 
     def blacklist_maj(self, ips):
+        """Mise à jour des blacklistes"""
         self.blacklist_hard_maj(ips)
         self.blacklist_soft_maj(ips)
         self.blacklist_upload_maj(ips)

gestion/gen_confs/firewall4/routeur.py

@@ -7,6 +7,10 @@ from utils import pretty_print, OK, anim
 from base import dev
 
 class firewall(base.firewall):
+    """
+    Pare-feu de la machine virtuelle routeur, gérant essentiellement le portail captif
+    et le routage des "petit" vlan (isolement, accueil…)
+    """
 
     def __init__(self):
         super(self.__class__, self).__init__()
@@ -50,7 +54,7 @@ class firewall(base.firewall):
         return
 
     def portail_captif_route(self, table=None, apply=False):
-        """PNAT les (ip,port)  laisser passer  travers le portail captif"""
+        """PNAT les (ip,port) à laisser passer à travers le portail captif"""
         chain = 'CAPTIF-ROUTE'
 
         if table == 'filter':

gestion/gen_confs/firewall4/zamok.py

@@ -8,7 +8,7 @@ from utils import pretty_print, OK, anim
 from base import dev
 
 class firewall(base.firewall):
-
+    """Pare-feu de zamok, le serveur des adhérents"""
     def __init__(self):
         super(self.__class__, self).__init__()