# LoopX Build Tools: Setuptools and MkDocs Configuration Guide > Discover LoopX build tools: setuptools for Python packaging and MkDocs for documentation. Learn how to configure pyproject.toml and mkdocs.yaml for efficient development. - Repository: [huangruiteng/loopx](https://github.com/huangruiteng/loopx) - Tags: how-to-guide - Published: 2026-08-11 --- **LoopX uses setuptools as its Python package build backend and MkDocs with the Material theme for documentation generation, configured via [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml) and [`mkdocs.yaml`](https://github.com/huangruiteng/loopx/blob/main/mkdocs.yaml).** The huangruiteng/loopx repository employs a streamlined set of build tools to create distributable Python packages and static documentation sites. These tools are defined in specific configuration files that control everything from wheel generation to documentation theming. ## Python Package Build System LoopX leverages **setuptools** (version 83.0.0) as its core build backend for creating distributable Python packages. ### Build Backend Configuration The `[build-system]` section in [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml) declares `setuptools.build_meta` as the build backend. This configuration directs `python -m build` to invoke setuptools when generating wheels and source distributions. ### Building the Package To build the LoopX package locally, use the standard Python build frontend: ```bash # Install the build tool once pip install build # Generate wheel and source distribution python -m build ``` This command produces artifacts in the `dist/` directory: - `dist/loopx-0.4.4-py3-none-any.whl` (wheel) - `dist/loopx-0.4.4.tar.gz` (source archive) For development installs without building: ```bash # Editable install for development pip install -e . ``` ## Documentation Site Generation LoopX uses **MkDocs** with the **Material for MkDocs** theme to generate its documentation site, supplemented by `pymdown-extensions` for enhanced Markdown rendering. ### MkDocs Configuration The [`mkdocs.yaml`](https://github.com/huangruiteng/loopx/blob/main/mkdocs.yaml) file controls the documentation structure, theme settings, plugins, and navigation. Dependencies for the documentation build are pinned in [`docs/requirements-docs.txt`](https://github.com/huangruiteng/loopx/blob/main/docs/requirements-docs.txt), which includes specific versions of MkDocs and the Material theme. ### Generating Documentation First install the documentation-specific dependencies: ```bash pip install -r docs/requirements-docs.txt ``` Then use MkDocs commands to preview or build: ```bash # Start live-reload server at http://127.0.0.1:8000 mkdocs serve # Build static site to output/docs-site/ mkdocs build ``` The built site outputs to `output/docs-site/` as configured in the build process. ## Development Workflow Tools While not strictly build tools, LoopX defines optional development dependencies under `[project.optional-dependencies]` in [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml). These include **ruff** for linting, **mypy** for type checking, and **pytest** for testing. These tools ensure code quality but are not required for the core build process: ```bash # Linting ruff check . # Type checking mypy . # Testing with parallel execution pytest -n auto ``` ## Key Configuration Files The following files define the complete build pipeline for LoopX: - **[`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml)** – Contains the `[build-system]` section declaring setuptools as the backend, along with `[project.optional-dependencies]` for development tools. - **[`mkdocs.yaml`](https://github.com/huangruiteng/loopx/blob/main/mkdocs.yaml)** – Configures the MkDocs site structure, Material theme, and Markdown extensions. - **[`docs/requirements-docs.txt`](https://github.com/huangruiteng/loopx/blob/main/docs/requirements-docs.txt)** – Pins exact versions of MkDocs, Material theme, and supporting libraries used for documentation builds. - **[`README.md`](https://github.com/huangruiteng/loopx/blob/main/README.md)** – Serves as the package long description, referenced by the build configuration. Notably, the project does not use [`setup.cfg`](https://github.com/huangruiteng/loopx/blob/main/setup.cfg); all packaging configuration resides in [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml) according to the huangruiteng/loopx source code. ## Summary - **LoopX build tools** center on setuptools for package distribution and MkDocs for documentation. - The build backend `setuptools.build_meta` is declared in [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml), producing wheels in the `dist/` folder. - Documentation builds use MkDocs with the Material theme, outputting to `output/docs-site/`. - Development tools (ruff, mypy, pytest) are optional dependencies defined in [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml) under `[project.optional-dependencies]`. - No [`setup.cfg`](https://github.com/huangruiteng/loopx/blob/main/setup.cfg) is used; all build configuration is centralized in [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml). ## Frequently Asked Questions ### What build backend does LoopX use? LoopX uses **setuptools** (specifically version 83.0.0) as its build backend. The `[build-system]` table in [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml) specifies `setuptools.build_meta` as the build backend, which handles the conversion of source code into distributable wheels and tar archives. ### How do I build the LoopX documentation locally? Install the documentation requirements from [`docs/requirements-docs.txt`](https://github.com/huangruiteng/loopx/blob/main/docs/requirements-docs.txt), then run `mkdocs serve` to start a live-reload development server at `http://127.0.0.1:8000`. For static output, use `mkdocs build`, which generates files in `output/docs-site/`. ### Are development tools required to build the LoopX package? No. Tools like **ruff**, **mypy**, and **pytest** are defined under `[project.optional-dependencies]` in [`pyproject.toml`](https://github.com/huangruiteng/loopx/blob/main/pyproject.toml) and are used for code quality assurance. They are not required for the core build process, which only needs setuptools as defined in the `[build-system]` section. ### Where does LoopX store build artifacts? Python package artifacts (wheels and source distributions) are stored in the `dist/` directory after running `python -m build`. Documentation artifacts are output to `output/docs-site/` when running `mkdocs build`.