From 3a4b9a14c759b22e7a26cb4c5729f6bd031a2838 Mon Sep 17 00:00:00 2001 From: Mirko Dietrich Date: Thu, 13 Jun 2024 19:44:47 +0200 Subject: [PATCH] docs: remove mkdocs We don't document server interals in the reference pages, and `questionpy_common` is re-exported through the `questionpy` module. Thus we remove mkdocs from this project entirely. --- docs/api.md | 7 ------- docs/collector.md | 15 --------------- docs/common/api/attempt.md | 5 ----- docs/common/api/index.md | 5 ----- docs/common/api/qtype.md | 5 ----- docs/common/api/question.md | 5 ----- docs/common/conditions.md | 7 ------- docs/common/constants.md | 5 ----- docs/common/elements.md | 8 -------- docs/common/index.md | 5 ----- docs/common/manifest.md | 7 ------- docs/factories.md | 3 --- docs/server.md | 13 ------------- docs/worker.md | 5 ----- mkdocs.yml | 8 -------- questionpy_common/manifest.py | 2 +- 16 files changed, 1 insertion(+), 104 deletions(-) delete mode 100644 docs/api.md delete mode 100644 docs/collector.md delete mode 100644 docs/common/api/attempt.md delete mode 100644 docs/common/api/index.md delete mode 100644 docs/common/api/qtype.md delete mode 100644 docs/common/api/question.md delete mode 100644 docs/common/conditions.md delete mode 100644 docs/common/constants.md delete mode 100644 docs/common/elements.md delete mode 100644 docs/common/index.md delete mode 100644 docs/common/manifest.md delete mode 100644 docs/factories.md delete mode 100644 docs/server.md delete mode 100644 docs/worker.md delete mode 100644 mkdocs.yml diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index 44da5eb2..00000000 --- a/docs/api.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: questionpy_server.api ---- - -::: questionpy_server.api.models - -::: questionpy_server.api.routes diff --git a/docs/collector.md b/docs/collector.md deleted file mode 100644 index dc6fd6fe..00000000 --- a/docs/collector.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: questionpy_server.collector ---- - -::: questionpy_server.collector.abc - -::: questionpy_server.collector.indexer - -::: questionpy_server.collector.lms_collector - -::: questionpy_server.collector.local_collector - -::: questionpy_server.collector.package_collection - -::: questionpy_server.collector.repo_collector diff --git a/docs/common/api/attempt.md b/docs/common/api/attempt.md deleted file mode 100644 index 817524a3..00000000 --- a/docs/common/api/attempt.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: attempt ---- - -::: questionpy_common.api.attempt diff --git a/docs/common/api/index.md b/docs/common/api/index.md deleted file mode 100644 index 85b4a245..00000000 --- a/docs/common/api/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: api ---- - -::: questionpy_common.api diff --git a/docs/common/api/qtype.md b/docs/common/api/qtype.md deleted file mode 100644 index ec9dac09..00000000 --- a/docs/common/api/qtype.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: qtype ---- - -::: questionpy_common.api.qtype diff --git a/docs/common/api/question.md b/docs/common/api/question.md deleted file mode 100644 index b0e056fc..00000000 --- a/docs/common/api/question.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: question ---- - -::: questionpy_common.api.question diff --git a/docs/common/conditions.md b/docs/common/conditions.md deleted file mode 100644 index 41fb394f..00000000 --- a/docs/common/conditions.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: conditions ---- - -::: questionpy_common.conditions - options: - show_if_no_docstring: true diff --git a/docs/common/constants.md b/docs/common/constants.md deleted file mode 100644 index 6b7e370d..00000000 --- a/docs/common/constants.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: constants ---- - -::: questionpy_common.constants diff --git a/docs/common/elements.md b/docs/common/elements.md deleted file mode 100644 index 9c2202fc..00000000 --- a/docs/common/elements.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: elements ---- - -::: questionpy_common.elements - options: - show_if_no_docstring: true - filters: ["!__all__", "!FormElement"] diff --git a/docs/common/index.md b/docs/common/index.md deleted file mode 100644 index 534b3b61..00000000 --- a/docs/common/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: questionpy_common ---- - -::: questionpy_common diff --git a/docs/common/manifest.md b/docs/common/manifest.md deleted file mode 100644 index 62eae3d7..00000000 --- a/docs/common/manifest.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: manifest ---- - -::: questionpy_common.manifest - options: - show_if_no_docstring: true diff --git a/docs/factories.md b/docs/factories.md deleted file mode 100644 index 53988472..00000000 --- a/docs/factories.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: questionpy_server.factories ---- diff --git a/docs/server.md b/docs/server.md deleted file mode 100644 index 8517d0e2..00000000 --- a/docs/server.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: questionpy_server.server ---- - -A short description of the QuestionPy Server can be put here. -This can also be automated with mkdocstrings, if the questionpy_server -package's `__init__.py` file contains a docstring. - -::: questionpy_server - options: - heading_level: 2 - show_if_no_heading: true - show_submodules: true diff --git a/docs/worker.md b/docs/worker.md deleted file mode 100644 index dfb9798b..00000000 --- a/docs/worker.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: questionpy_server.worker ---- - -::: questionpy_server.worker.runtime diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 7dab3475..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,8 +0,0 @@ -site_name: reference/server - -nav: - - api.md - - collector.md - - factories.md - - server.md - - worker.md diff --git a/questionpy_common/manifest.py b/questionpy_common/manifest.py index 4f782936..5f110455 100644 --- a/questionpy_common/manifest.py +++ b/questionpy_common/manifest.py @@ -38,7 +38,7 @@ class PackageType(StrEnum): def ensure_is_valid_name(name: str) -> str: """Ensures valid package name. - Checks that `name` follows the [naming rules](../../documentation/configuration.md#short_name). + Checks that `name` follows the [naming rules](../../../documentation/configuration.md#short_name). Args: name: the name to be checked