Rewrite documentation with MkDocs

core/management/commands/documentation.py

@@ -1,90 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright 2019
-# - Sli <antoine@bartuccio.fr>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-import os
-import signal
-import sys
-from http.server import CGIHTTPRequestHandler, test
-
-from django.core.management.base import BaseCommand
-from django.utils import autoreload
-
-
-class Command(BaseCommand):
-    help = "Generate Sphinx documentation and launch basic server"
-
-    default_addr = "127.0.0.1"
-    default_port = "8080"
-
-    def add_arguments(self, parser):
-        parser.add_argument(
-            "addrport", nargs="?", help="Optional port number, or ipaddr:port"
-        )
-
-    def build_documentation(self):
-        os.chdir(os.path.join(self.project_dir, "doc"))
-        err = os.system("make html")
-
-        if err != 0:
-            self.stdout.write("A build error occured")
-
-    def start_server(self, **kwargs):
-        os.chdir(os.path.join(self.project_dir, "doc", "_build/html"))
-        addr = self.default_addr
-        port = self.default_port
-        if kwargs["addrport"]:
-            addrport = kwargs["addrport"].split(":")
-
-            addr = addrport[0]
-
-            if len(addrport) > 1:
-                port = addrport[1]
-
-            if not port.isnumeric():
-                self.stdout.write("%s is not a valid port" % (port,))
-                sys.exit(0)
-
-        test(HandlerClass=CGIHTTPRequestHandler, port=int(port), bind=addr)
-
-    def build_and_start_server(self, **kwargs):
-        self.build_documentation()
-        self.start_server(**kwargs)
-
-    def handle(self, *args, **kwargs):
-        self.project_dir = os.getcwd()
-
-        signal.signal(signal.SIGTERM, lambda *args: sys.exit(0))
-        try:
-            if os.environ.get(autoreload.DJANGO_AUTORELOAD_ENV) == "true":
-                reloader = autoreload.get_reloader()
-                reloader.watch_dir(os.path.join(self.project_dir, "doc"), "**/*.rst")
-                autoreload.logger.info(
-                    "Watching for file changes with %s", reloader.__class__.__name__
-                )
-                autoreload.start_django(reloader, self.build_and_start_server, **kwargs)
-            else:
-                exit_code = autoreload.restart_with_reloader()
-                sys.exit(exit_code)
-        except KeyboardInterrupt:
-            pass

core/management/commands/markdown.py

@@ -21,20 +21,19 @@
 #
 #
 
-import os
+from pathlib import Path
 
+from django.conf import settings
 from django.core.management.base import BaseCommand
 
 from core.markdown import markdown
 
 
 class Command(BaseCommand):
-    help = "Output the fully rendered doc/SYNTAX.md file"
+    help = "Output the fully rendered SYNTAX.md file"
 
     def handle(self, *args, **options):
-        root_path = os.path.dirname(
-            os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
-        )
-        with open(os.path.join(root_path) + "/doc/SYNTAX.md", "r") as md:
+        root_path = Path(settings.BASE_DIR)
+        with open(root_path / "core/fixtures/SYNTAX.md", "r") as md:
             result = markdown(md.read())
         print(result, end="")

core/management/commands/populate.py

@@ -383,7 +383,7 @@ Welcome to the wiki page!
             # Adding syntax help page
             p = Page(name="Aide_sur_la_syntaxe")
             p.save(force_lock=True)
-            with open(root_path / "doc" / "SYNTAX.md", "r") as rm:
+            with open(root_path / "core" / "fixtures" / "SYNTAX.md", "r") as rm:
                 PageRev(
                     page=p, title="Aide sur la syntaxe", author=skia, content=rm.read()
                 ).save()