Skip to content

Commit

Permalink
docs: remove mkdocs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
tumidi committed Jun 14, 2024
1 parent 763c15b commit 3a4b9a1
Show file tree
Hide file tree
Showing 16 changed files with 1 addition and 104 deletions.
7 changes: 0 additions & 7 deletions docs/api.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/collector.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/common/api/attempt.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/common/api/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/common/api/qtype.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/common/api/question.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/common/conditions.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/common/constants.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/common/elements.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/common/index.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/common/manifest.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/factories.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/server.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/worker.md

This file was deleted.

8 changes: 0 additions & 8 deletions mkdocs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion questionpy_common/manifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3a4b9a1

Please sign in to comment.