liblaf-mkdocs-preset 0.1.0__tar.gz

liblaf_mkdocs_preset-0.1.0/.gitignore

@@ -0,0 +1,192 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+# pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+
+# hatch-vcs
+_version.py
+
+# pytest
+junit.xml
+
+# pytest-benchmark
+.benchmarks/
+
+# pytest-codspeed
+.codspeed/
+
+*.log
+*.log.*
+playground/

liblaf_mkdocs_preset-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 liblaf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

liblaf_mkdocs_preset-0.1.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: liblaf-mkdocs-preset
+Version: 0.1.0
+Summary: TODO
+Project-URL: Changelog, https://github.com/liblaf/mkdocs-preset/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://liblaf.github.io/mkdocs-preset/
+Project-URL: Funding, https://github.com/liblaf/mkdocs-preset?sponsor=1
+Project-URL: Homepage, https://github.com/liblaf/mkdocs-preset
+Project-URL: Issue Tracker, https://github.com/liblaf/mkdocs-preset/issues
+Project-URL: Release Notes, https://github.com/liblaf/mkdocs-preset/releases
+Project-URL: Source Code, https://github.com/liblaf/mkdocs-preset
+Author-email: liblaf <30631553+liblaf@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: docstring-inheritance<3,>=2
+Requires-Dist: griffe-fieldz<0.4,>=0.3
+Requires-Dist: griffe-generics<2,>=1
+Requires-Dist: griffe-inherited-docstrings<2,>=1
+Requires-Dist: griffe-modernized-annotations<2,>=1
+Requires-Dist: griffe-pydantic<2,>=1
+Requires-Dist: griffe-warnings-deprecated<2,>=1
+Requires-Dist: mdx-truly-sane-lists<2,>=1
+Requires-Dist: mkdocs-api-autonav<0.4,>=0.3
+Requires-Dist: mkdocs-autorefs<2,>=1
+Requires-Dist: mkdocs-git-committers-plugin-2<3,>=2
+Requires-Dist: mkdocs-git-revision-date-localized-plugin<2,>=1
+Requires-Dist: mkdocs-include-markdown-plugin<8,>=7
+Requires-Dist: mkdocs-material[imaging]<10,>=9
+Requires-Dist: mkdocs-section-index<0.4,>=0.3
+Requires-Dist: mkdocs<2,>=1
+Requires-Dist: mkdocstrings[python]<0.31,>=0.30
+Requires-Dist: pymdown-extensions<11,>=10
+Requires-Dist: ruff<0.13,>=0.12
+Description-Content-Type: text/markdown
+
+# mkdocs-preset

liblaf_mkdocs_preset-0.1.0/README.md

@@ -0,0 +1 @@
+# mkdocs-preset

liblaf_mkdocs_preset-0.1.0/pyproject.toml

@@ -0,0 +1,100 @@
+#:schema https://json.schemastore.org/pyproject.json
+# ref: <https://packaging.python.org/en/latest/specifications/pyproject-toml/>
+
+[project]
+name = "liblaf-mkdocs-preset"
+description = "TODO"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+authors = [
+  { name = "liblaf", email = "30631553+liblaf@users.noreply.github.com" },
+]
+keywords = []
+classifiers = [
+  # ref: <https://pypi.org/classifiers/>
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+]
+dependencies = [
+  "docstring-inheritance>=2,<3",
+  "griffe-fieldz>=0.3,<0.4",
+  "griffe-generics>=1,<2",
+  "griffe-inherited-docstrings>=1,<2",
+  "griffe-modernized-annotations>=1,<2",
+  "griffe-pydantic>=1,<2",
+  "griffe-warnings-deprecated>=1,<2",
+  "mdx-truly-sane-lists>=1,<2",
+  "mkdocs-api-autonav>=0.3,<0.4",
+  "mkdocs-autorefs>=1,<2",
+  "mkdocs-git-committers-plugin-2>=2,<3",
+  "mkdocs-git-revision-date-localized-plugin>=1,<2",
+  "mkdocs-include-markdown-plugin>=7,<8",
+  "mkdocs-material[imaging]>=9,<10",
+  "mkdocs-section-index>=0.3,<0.4",
+  "mkdocs>=1,<2",
+  "mkdocstrings[python]>=0.30,<0.31",
+  "pymdown-extensions>=10,<11",
+  "ruff>=0.12,<0.13",
+]
+dynamic = ["version"]
+
+[project.urls]
+"Changelog" = "https://github.com/liblaf/mkdocs-preset/blob/main/CHANGELOG.md"
+"Documentation" = "https://liblaf.github.io/mkdocs-preset/"
+"Funding" = "https://github.com/liblaf/mkdocs-preset?sponsor=1"
+"Homepage" = "https://github.com/liblaf/mkdocs-preset"
+"Issue Tracker" = "https://github.com/liblaf/mkdocs-preset/issues"
+"Release Notes" = "https://github.com/liblaf/mkdocs-preset/releases"
+"Source Code" = "https://github.com/liblaf/mkdocs-preset"
+
+[dependency-groups]
+build = ["check-wheel-contents", "hatch", "twine"]
+dev = ["icecream"]
+docs = []
+test = ["hypothesis", "pytest", "pytest-codspeed", "pytest-cov", "pytest-xdist"]
+
+[build-system]
+requires = ["hatch-vcs", "hatchling"]
+build-backend = "hatchling.build"
+
+[tool.check-wheel-contents]
+ignore = ["W002"]
+
+[tool.coverage.run]
+branch = true
+source = ["src"]
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/liblaf/mkdocs_preset/_version.py"
+
+[tool.hatch.build.targets.sdist]
+only-include = ["src"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/liblaf"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.pyright]
+exclude = ["**/.*", "**/__pycache__", "**/marimo", "**/node_modules"]
+extends = ".config/linters/pyrightconfig.json"
+
+[tool.pytest.ini_options]
+addopts = ["--showlocals", "--strict-config", "--strict-markers"]
+testpaths = ["benches", "tests"]
+
+[tool.ruff]
+extend = ".config/linters/.ruff.toml"
+
+[tool.uv]
+default-groups = "all"

liblaf_mkdocs_preset-0.1.0/src/liblaf/mkdocs_preset/__init__.py

@@ -0,0 +1,3 @@
+from ._version import __version__, __version_tuple__, version, version_tuple
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]

liblaf_mkdocs_preset-0.1.0/src/liblaf/mkdocs_preset/__init__.pyi

@@ -0,0 +1,3 @@
+from ._version import __version__, __version_tuple__, version, version_tuple
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]

liblaf_mkdocs_preset-0.1.0/src/liblaf/mkdocs_preset/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None

liblaf_mkdocs_preset-0.1.0/src/liblaf/mkdocs_preset/_version.pyi

@@ -0,0 +1,8 @@
+# This file is @generated by <https://github.com/liblaf/copier-python>.
+# DO NOT EDIT!
+
+# ref: <https://github.com/ofek/hatch-vcs>
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+version: str