Clean and refactor codebase

- Removed unused/old modules/files - Splited mkdocs_macro.py - Moved datafiles to pulp_docs/data - Added some docstrings
pulp · Dec 28, 2023 · 4a0a250 · 4a0a250
1 parent 693dba1
commit 4a0a250
Show file tree

Hide file tree

Showing 198 changed files with 231 additions and 506,295 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -21,7 +21,7 @@ pulp-docs = "pulp_docs.main:main"
 include-package-data=true
 
 [tool.setuptools.package-data]
-pulp_docs = ["mkdocs.yml", "docs/"]
+pulp_docs = ["data/**"]
 
 [tool.setuptools.packages.find]
 where = ["src"]

diff --git a/scripts/build_docs-deprecated.py b/scripts/build_docs-deprecated.py
diff --git a/scripts/download-latest-gh-release.sh b/scripts/download-latest-gh-release.sh
diff --git a/scripts/update-repos.sh b/scripts/update-repos.sh
diff --git a/src/pulp_docs/docs/assets/hero-img.png → src/pulp_docs/data/docs/assets/hero-img.png b/src/pulp_docs/docs/assets/hero-img.png → src/pulp_docs/data/docs/assets/hero-img.png
diff --git a/src/pulp_docs/docs/assets/logo.png → src/pulp_docs/data/docs/assets/logo.png b/src/pulp_docs/docs/assets/logo.png → src/pulp_docs/data/docs/assets/logo.png
diff --git a/src/pulp_docs/docs/css/extra.css → src/pulp_docs/data/docs/css/extra.css b/src/pulp_docs/docs/css/extra.css → src/pulp_docs/data/docs/css/extra.css
diff --git a/src/pulp_docs/docs/css/mkdocstrings.css → src/pulp_docs/data/docs/css/mkdocstrings.css b/src/pulp_docs/docs/css/mkdocstrings.css → src/pulp_docs/data/docs/css/mkdocstrings.css
diff --git a/src/pulp_docs/docs/tags.md → src/pulp_docs/data/docs/tags.md b/src/pulp_docs/docs/tags.md → src/pulp_docs/data/docs/tags.md
diff --git a/src/pulp_docs/mkdocs.yml → src/pulp_docs/data/mkdocs.yml b/src/pulp_docs/mkdocs.yml → src/pulp_docs/data/mkdocs.yml
@@ -36,7 +36,7 @@ theme:
 plugins:
   - search
   - macros:
-      module_name: 'mkdocs_macros'
+      module_name: '../mkdocs_macros'
   - tags:
       tags_file: pulp-docs/tags.md
   - mkdocstrings:

diff --git a/src/pulp_docs/repolist.yml → src/pulp_docs/data/repolist.yml b/src/pulp_docs/repolist.yml → src/pulp_docs/data/repolist.yml
diff --git a/src/pulp_docs/fetch_repos.py b/src/pulp_docs/fetch_repos.py
diff --git a/src/pulp_docs/main.py b/src/pulp_docs/main.py
@@ -1,12 +1,15 @@
+"""
+The main CLI module.
+
+It defines its interface.
+"""
 import subprocess
 import sys
 from pathlib import Path
 
 import click
 from importlib_resources import files
 
-from pulp_docs.fetch_repos import LocalRepo, download_repos
-
 TMP_DIR = Path("tmp")
 WORKDIR = Path.home() / "workspace" / "multirepo-prototype"
 
@@ -19,7 +22,7 @@ class Config:
     def __init__(self):
         self.verbose = False
         self.workdir = Path()
-        self.mkdocs_file = files("pulp_docs").joinpath("mkdocs.yml")
+        self.mkdocs_file = files("pulp_docs").joinpath("data/mkdocs.yml")
 
 
 pass_config = click.make_pass_decorator(Config, ensure=True)