doc: tweaks

.pre-commit-config.yaml

@@ -37,11 +37,11 @@ repos:
     - id: trailing-whitespace
     # Misc Python
     - id: debug-statements
-    - id: check-docstring-first
     - id: forbid-new-submodules
       args: ['--allow-missing-credentials']
     - id: fix-encoding-pragma
       args: ['--remove']
+    # - id: check-docstring-first
     # - id: name-tests-test
     # - id: no-commit-to-branch
     # - id: requirements-txt-fixer

doc/Makefile

@@ -11,11 +11,11 @@ src/dev/orchestrator.md: ../nua_orchestrator_local/README.md
 	cp ../nua_orchestrator_local/README.md src/dev/orchestrator.md
 
 run: $(src)
-	./scripts/gen-api.py
+	python ./scripts/gen-api.py
 	mkdocs serve
 
 build: $(src)
-	./scripts/gen-api.py
+	python ./scripts/gen-api.py
 	mkdocs build
 	cp -a src/.well-known site/
 	cp -a assets/root/* site/

doc/scripts/gen-api.py

@@ -17,7 +17,8 @@ class Generator:
 
     def __post_init__(self):
         self.root_dir = Path("..") / self.source / "src"
-        self.output = (Path("src") / "dev" / "api" / f"{self.source}.md").open("w")
+        self.output = []
+        self.output_file = (Path("src") / "dev" / "api" / f"{self.source}.md").open("w")
 
     def generate_spi(self):
         """Generate API documentation."""
@@ -39,8 +40,10 @@ def generate_spi(self):
                 self.print(f"::: {module_name}")
             self.print()
 
-    def print(self, *args, **kwargs):
-        print(*args, **kwargs, file=self.output)
+        self.output_file.write("\n".join(self.output).strip() + "\n")
+
+    def print(self, *args):
+        self.output.append(" ".join(args))
 
 
 def main():

nua-lib/src/nua/lib/constants.py

@@ -9,9 +9,16 @@
 
 # In the container:
 NUA_BUILD_PATH = "/nua/build"
+"""The directory where the application is built."""
+
 NUA_APP_PATH = "/nua/app"
+"""The directory where the application is installed."""
+
 NUA_METADATA_PATH = "/nua/metadata"
+"""The directory where the application metadata is stored."""
+
 NUA_SCRIPTS_PATH = "/nua/scripts"
+"""The directory where the operation and maintenance scripts are stored."""
 
 
 def nua_config_names():