diff --git a/doc/Makefile b/doc/Makefile index df5f2ed1e839e3fd8edf369bbaba516cb63eb51b..4e2710136b7e5e19ab96ffefdee88aae8e9d326d 100644 --- a/doc/Makefile +++ b/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." diff --git a/doc/source/coverage.rst b/doc/source/coverage.rst new file mode 100644 index 0000000000000000000000000000000000000000..d9c8274559989253c33b94daaa5a31f76a311a19 --- /dev/null +++ b/doc/source/coverage.rst @@ -0,0 +1,9 @@ + +Objets non documentés +===================== + +Cette page liste les objets non documentés. + +.. include:: ../build/coverage/python.txt + :start-line: 2 + diff --git a/doc/source/gestion/config/mails/demenagement.rst b/doc/source/gestion/config/mails/demenagement.rst deleted file mode 100644 index f2b2d69db7b442c0f517b76cc600279bad13cfd0..0000000000000000000000000000000000000000 --- a/doc/source/gestion/config/mails/demenagement.rst +++ /dev/null @@ -1,6 +0,0 @@ -demenagement -- Template de mail pour le déménagement -===================================================== - -.. automodule:: gestion.config.mails.demenagement - :members: - diff --git a/doc/source/gestion/gen_confs/firewall4.rst b/doc/source/gestion/gen_confs/firewall4.rst deleted file mode 100644 index 5d59b2fbeb2a9ad1bf890d320ff936b0446b1833..0000000000000000000000000000000000000000 --- a/doc/source/gestion/gen_confs/firewall4.rst +++ /dev/null @@ -1,7 +0,0 @@ - -gen_confs.firewall4 -- Le pare-feu ipv4 -======================================= - -.. automodule:: gestion.gen_confs.firewall4 - :members: - :special-members: diff --git a/doc/source/gestion/gen_confs/firewall4/base.rst b/doc/source/gestion/gen_confs/firewall4/base.rst new file mode 100644 index 0000000000000000000000000000000000000000..5d4ca51cd81069098cfa3ac13f59ba527563f10b --- /dev/null +++ b/doc/source/gestion/gen_confs/firewall4/base.rst @@ -0,0 +1,7 @@ + +base -- Le pare-feu ipv4 de base +================================ + +.. automodule:: gestion.gen_confs.firewall4.base + :members: + :special-members: diff --git a/doc/source/gestion/gen_confs/firewall4/firewall4.rst b/doc/source/gestion/gen_confs/firewall4/firewall4.rst new file mode 100644 index 0000000000000000000000000000000000000000..8e38cfb8f03ba7ed509d1e99e58159a626af3fcb --- /dev/null +++ b/doc/source/gestion/gen_confs/firewall4/firewall4.rst @@ -0,0 +1,7 @@ + +firewall4 -- Le pare-feu ipv4 +============================= + +.. automodule:: gestion.gen_confs.firewall4.firewall4 + :members: + :special-members: diff --git a/doc/source/gestion/gen_confs/firewall4/index.rst b/doc/source/gestion/gen_confs/firewall4/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..8a5d5789210722942d4280a912263ad0269f5e5f --- /dev/null +++ b/doc/source/gestion/gen_confs/firewall4/index.rst @@ -0,0 +1,10 @@ +firewall4 -- Le pare-feu ipv4 +========================================== + +Table des matières : + +.. toctree:: + :maxdepth: 2 + :glob: + + * diff --git a/doc/source/gestion/gen_confs/firewall4/komaz.rst b/doc/source/gestion/gen_confs/firewall4/komaz.rst new file mode 100644 index 0000000000000000000000000000000000000000..8d641328363287a015c92c7f2f3abeb28a2ba707 --- /dev/null +++ b/doc/source/gestion/gen_confs/firewall4/komaz.rst @@ -0,0 +1,7 @@ + +komaz -- Le pare-feu ipv4 de komaz +================================== + +.. automodule:: gestion.gen_confs.firewall4.komaz + :members: + :special-members: diff --git a/doc/source/gestion/gen_confs/firewall4/routeur.rst b/doc/source/gestion/gen_confs/firewall4/routeur.rst new file mode 100644 index 0000000000000000000000000000000000000000..79341bb739c95bc8a382ade25f5e05594077c3e3 --- /dev/null +++ b/doc/source/gestion/gen_confs/firewall4/routeur.rst @@ -0,0 +1,7 @@ + +routeur -- Le pare-feu ipv4 de routeur +====================================== + +.. automodule:: gestion.gen_confs.firewall4.routeur + :members: + :special-members: diff --git a/doc/source/gestion/gen_confs/firewall4/utils.rst b/doc/source/gestion/gen_confs/firewall4/utils.rst new file mode 100644 index 0000000000000000000000000000000000000000..536e4042c9961241a771cda754c3cbf25fe76dae --- /dev/null +++ b/doc/source/gestion/gen_confs/firewall4/utils.rst @@ -0,0 +1,7 @@ + +utils -- Le pare-feu ipv4, les fonctions de manipulation +======================================================== + +.. automodule:: gestion.gen_confs.firewall4.utils + :members: + :special-members: diff --git a/doc/source/gestion/gen_confs/firewall4/zamok.rst b/doc/source/gestion/gen_confs/firewall4/zamok.rst new file mode 100644 index 0000000000000000000000000000000000000000..b06d65f313a52aef1f27fd4e79ffa9a780332802 --- /dev/null +++ b/doc/source/gestion/gen_confs/firewall4/zamok.rst @@ -0,0 +1,7 @@ + +zamok -- Le pare-feu ipv4 de zamok +================================== + +.. automodule:: gestion.gen_confs.firewall4.zamok + :members: + :special-members: diff --git a/doc/source/gestion/gen_confs/index.rst b/doc/source/gestion/gen_confs/index.rst index e44687018b02229cf793ded8b4ff92ceede11513..60727cfd0a33a8f7abbb705486bf171e2bbc8ca8 100644 --- a/doc/source/gestion/gen_confs/index.rst +++ b/doc/source/gestion/gen_confs/index.rst @@ -7,4 +7,6 @@ Table des matières : :maxdepth: 2 :glob: + firewall4/index + * diff --git a/doc/source/gestion/gest_crans_lc.rst b/doc/source/gestion/gest_crans_lc.rst new file mode 100644 index 0000000000000000000000000000000000000000..5490cbaf82b1adaabf57434a8fb5178b5edb255c --- /dev/null +++ b/doc/source/gestion/gest_crans_lc.rst @@ -0,0 +1,9 @@ +GestCrans -- Gestion des machines et adhérents du crans, version lc_ldap +======================================================================== + +.. automodule:: gestion.gest_crans_lc + :members: + :private-members: + :special-members: + :show-inheritance: + diff --git a/doc/source/gestion/index.rst b/doc/source/gestion/index.rst index 19759b2d0a32a5e14d8f1cb6f5ba33038472546c..331d4ec0247d4e0127bdaa15b1387a29f8f4b687 100644 --- a/doc/source/gestion/index.rst +++ b/doc/source/gestion/index.rst @@ -8,3 +8,4 @@ Table des matières : config/index gen_confs/index + gest_crans_lc diff --git a/doc/source/index.rst b/doc/source/index.rst index 3a66723d538231af419a193ebaeafc772ba238d4..df11be2273a8a5d677cb6f65858b616d305e8d67 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,6 +14,8 @@ Table des matières : gestion/index impression/index + others + Indices and tables ================== diff --git a/doc/source/others.rst b/doc/source/others.rst new file mode 100644 index 0000000000000000000000000000000000000000..df81b79a606cda1f266a8cbfcf6774b62a9c03f2 --- /dev/null +++ b/doc/source/others.rst @@ -0,0 +1,10 @@ + +Annexes +======= + +.. toctree:: + :maxdepth: 2 + + coverage +.. var/coverage + diff --git a/gestion/gen_confs/firewall4/komaz.py b/gestion/gen_confs/firewall4/komaz.py index 184d6d41ca37f424c73dc8f4954b6ba464b5a6f5..66207241997b844fb6b2116d60ea426f78188a95 100644 --- a/gestion/gen_confs/firewall4/komaz.py +++ b/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) diff --git a/gestion/gen_confs/firewall4/routeur.py b/gestion/gen_confs/firewall4/routeur.py index 55775c27b879f1081b2362ad75e2e6ca3925dcb6..6d67645cd13e44796c56b9401be8d569130c89db 100644 --- a/gestion/gen_confs/firewall4/routeur.py +++ b/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': diff --git a/gestion/gen_confs/firewall4/zamok.py b/gestion/gen_confs/firewall4/zamok.py index e3f0796dcd7f76b5820ef2cddd2632d1ae23b834..273bc6ee7df210ecaf7d3f5540bfedd89df1a807 100644 --- a/gestion/gen_confs/firewall4/zamok.py +++ b/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__()