mkdocs-texsmith 0.0.2.dev0__py3-none-any.whl

mkdocs_texsmith-0.0.2.dev0.dist-info/METADATA

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: mkdocs-texsmith
+Version: 0.0.2.dev0
+Summary: Convert MkDocs documentation to LaTeX PDF.
+Project-URL: Homepage, https://github.com/yves-chevallier/mkdocs-texsmith
+Author-email: Yves Chevallier <yves.chevalier@heig-vd.ch>
+License-Expression: MIT
+License-File: LICENSE.md
+Keywords: convert,extensions,latex,markdown,mkdocs,texsmith
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: texsmith==0.0.2.dev0
+Description-Content-Type: text/markdown
+
+# MkDocs TeXSmith Plugin
+
+`mkdocs-texsmith` turns any MkDocs project into a set of LaTeX sources ready for high-quality PDF production. The plugin reuses the TeXSmith rendering pipeline to transform the pages that MkDocs renders into TeX, keeping navigation structure, numbering, cross references, and assets in sync.
+
+## Highlights
+
+- Export one or many "books" from the same MkDocs site, each with its own metadata and output folder.
+- Reuse TeXSmith templates or override individual blocks to match your house style.
+- Combine global `.bib` files, per-book bibliographies, inline citations, and DOI lookups into a single bibliography.
+- Copy and prune assets automatically so only referenced images end up in the LaTeX project.
+- Optional HTML snapshots for debugging, plus Material for MkDocs specific tweaks out of the box.
+
+## Installation
+
+```bash
+pip install mkdocs-texsmith
+```
+
+The package targets Python 3.12+. If you manage dependencies with [uv](https://github.com/astral-sh/uv), run:
+
+```bash
+uv add mkdocs-texsmith
+```
+
+## Quick Start
+
+1. Add the plugin to your `mkdocs.yml`.
+
+   ```yaml
+   plugins:
+     - search
+     - texsmith:
+         build_dir: press # where LaTeX sources are written
+         template: book # TeXSmith template to use
+         bibliography:
+           - docs/references.bib
+   ```
+
+2. Build your site as usual:
+
+   ```bash
+   mkdocs build
+   ```
+
+3. The LaTeX project for each configured book is created under `press/`. Compile the resulting `index.tex` with your preferred tool (`latexmk`, `tectonic`, etc.) to produce the PDF.
+
+## Configuration
+
+All plugin options are declared under the `texsmith` plugin entry.
+
+- `enabled` (bool): turns the plugin on or off; automatically disabled during `mkdocs serve`.
+- `build_dir` (str): output root for generated LaTeX projects. Defaults to `press`.
+- `template` (str): default TeXSmith template name. Falls back to `book`.
+- `parser` (str): HTML parser backend used by TeXSmith (`lxml` by default).
+- `copy_assets` (bool): copy images and other assets referenced by the book into the build directory.
+- `clean_assets` (bool): remove unused files from the generated `assets/` folder after rendering.
+- `save_html` (bool): if `true`, store the rendered HTML alongside LaTeX snapshots under `html/`.
+- `language` (str): override auto-detected language for templates and hyphenation.
+- `bibliography` (list[str]): global `.bib` files applied to every book.
+- `books` (list[dict]): per-book configuration (see below).
+- `template_overrides` (dict[str, str]): map of template block names to override files.
+- `register_material` (bool): register Material for MkDocs specific renderers (enabled by default).
+
+### Multiple books
+
+The `books` list lets you export distinct artefacts from the same site. Each entry accepts [`BookConfig`](../../src/texsmith/core/config.py) fields plus book-specific extras (`template`, `template_overrides`, `bibliography`):
+
+```yaml
+plugins:
+  - texsmith:
+      books:
+        - title: "User Guide"
+          root: "Guide"
+          folder: "user-guide"
+          template: book
+          bibliography:
+            - docs/guide.bib
+        - title: "API Reference"
+          root: "Reference"
+          base_level: 2
+          copy_files:
+            docs/appendix/*.tex: backmatter/
+```
+
+If you do not declare any books, the plugin creates one automatically using the first navigation page as the root section.
+
+### Bibliography sources
+
+- Global `bibliography` files apply to every book.
+- Book-level `bibliography` entries augment or override the global list.
+- YAML front matter can declare inline bibliography entries, including DOI links. DOIs are resolved at build time; failures are logged but do not stop the build.
+- Per-book `.bib` files are emitted with the LaTeX project, and an `assets_map.yml` manifest records the asset locations used by the renderer.
+
+### Templates and overrides
+
+TeXSmith templates bundle LaTeX, Jinja, and formatter fragments. Set `template` globally or per book, then override specific fragments via `template_overrides`:
+
+```yaml
+plugins:
+  - texsmith:
+      template: book
+      template_overrides:
+        heading: overrides/heading.j2
+      books:
+        - title: "Whitepaper"
+          template_overrides:
+            cover: overrides/custom_cover.tex.j2
+```
+
+The plugin automatically registers TeXSmith's Material integration when `register_material` is `true`, aligning colors and fonts with the Material theme if you use it.
+
+### Assets and HTML snapshots
+
+- `copy_assets: true` copies images and other referenced files into `<build_dir>/<book>/assets/`.
+- `clean_assets: true` prunes unused files after rendering, keeping the LaTeX project tidy.
+- Enable `save_html` to keep the intermediate HTML for each page under `<build_dir>/<book>/html/`, which helps when troubleshooting rendering issues.
+
+## Development
+
+1. Clone the repository and install dependencies:
+
+   ```bash
+   uv sync
+   ```
+
+2. Run the documentation site locally:
+
+   ```bash
+   uv run mkdocs serve
+   ```
+
+3. Use `pytest` or `uv run pytest` to execute tests before contributing patches.
+
+The repository maintains a `Makefile` shortcut (`make deps`) that mirrors the `uv sync` step.
+
+## License
+
+The project is distributed under the MIT License. See `LICENSE.md` for the full text.

mkdocs_texsmith-0.0.2.dev0.dist-info/RECORD

@@ -0,0 +1,7 @@
+mkdocs_plugin_texsmith/__init__.py,sha256=YO_yRdtojJvjdEO5FWDQ7S3PUhaaWRtcSCumfcB50ps,96
+mkdocs_plugin_texsmith/plugin.py,sha256=SyLWiI3LutSp7EKqucECCTBNI4NFJUGQzn8Ine2mjXw,53910
+mkdocs_texsmith-0.0.2.dev0.dist-info/METADATA,sha256=BTnBpjYHuJDd3MZtlRRHetIr6OUKqPlRBCMFYtFwHE4,6072
+mkdocs_texsmith-0.0.2.dev0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+mkdocs_texsmith-0.0.2.dev0.dist-info/entry_points.txt,sha256=hPPD4tbTS19gLtCR-GSMMMojBp3SWHZmiElEh9GOM6g,63
+mkdocs_texsmith-0.0.2.dev0.dist-info/licenses/LICENSE.md,sha256=cGypyOtV6cq8aMvQvtj_3GdN2YDxl37sq5GD9GN8cWA,1066
+mkdocs_texsmith-0.0.2.dev0.dist-info/RECORD,,

mkdocs_texsmith-0.0.2.dev0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

mkdocs_texsmith-0.0.2.dev0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mkdocs.plugins]
+texsmith = mkdocs_plugin_texsmith:LatexPlugin

mkdocs_texsmith-0.0.2.dev0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Isaac Muse
+
+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.