sphinx-mkdocs-migrate 0.0.1.dev0__py3-none-any.whl

sphinx_mkdocs_migrate/validator/verifier.py

@@ -0,0 +1,377 @@
+"""CommonMark structural validation and isolated Sphinx build verification engine."""
+
+import re
+import sys
+import shutil
+import subprocess
+import tempfile
+import importlib.util
+from pathlib import Path
+from typing import List, Tuple
+from markdown_it import MarkdownIt
+from .models import ValidationReport, ValidationIssue, ValidationSeverity
+from ..transformer.models import ProjectTransformationReport
+
+
+class TransformationValidator:
+    """Validates transformed Markdown via CommonMark parsing, directive structure checks, and isolated Sphinx execution."""
+
+    def __init__(self):
+        self.md_parser = MarkdownIt("commonmark", {"html": True}).enable("table")
+
+    def validate_transformation_report(
+        self,
+        report: ProjectTransformationReport,
+        run_sphinx_build: bool = False,
+        strict_warnings: bool = False,
+    ) -> ValidationReport:
+        """Validates all transformed documents in a ProjectTransformationReport and optionally executes an isolated Sphinx build."""
+        issues: List[ValidationIssue] = []
+        cm_parse_ok = True
+        struct_ok = True
+
+        for doc in report.transformed_documents:
+            doc_issues = self.validate_structural_syntax(
+                doc.target_file, doc.transformed_content
+            )
+            issues.extend(doc_issues)
+            if any(i.severity == ValidationSeverity.ERROR for i in doc_issues):
+                cm_parse_ok = False
+                struct_ok = False
+
+        # Validate conf.py existence and structure
+        conf_keys = [
+            k for k in report.generated_sphinx_files.keys() if k.endswith("conf.py")
+        ]
+        if not conf_keys:
+            issues.append(
+                ValidationIssue(
+                    file_path="conf.py",
+                    severity=ValidationSeverity.ERROR,
+                    issue_type="MISSING_CONF_PY",
+                    message="Sphinx conf.py was not generated in transformation report.",
+                )
+            )
+            struct_ok = False
+        else:
+            conf_content = report.generated_sphinx_files[conf_keys[0]]
+            if "extensions =" not in conf_content or "myst_parser" not in conf_content:
+                issues.append(
+                    ValidationIssue(
+                        file_path=conf_keys[0],
+                        severity=ValidationSeverity.ERROR,
+                        issue_type="INVALID_CONF_PY",
+                        message="Generated conf.py is missing myst_parser extension.",
+                    )
+                )
+                struct_ok = False
+
+        sphinx_build_attempted = False
+        sphinx_build_successful = None
+        build_output = None
+        sphinx_warning_count = 0
+        sphinx_warnings: List[str] = []
+        sphinx_theme_status = None
+
+        # Execute real Sphinx build in an isolated sandbox directory if requested
+        if run_sphinx_build and struct_ok:
+            sphinx_build_attempted = True
+            build_ok, output, warnings, theme_status = self._execute_real_sphinx_build(
+                report, strict_warnings=strict_warnings
+            )
+            sphinx_build_successful = build_ok
+            build_output = output
+            sphinx_warnings = warnings
+            sphinx_warning_count = len(warnings)
+            sphinx_theme_status = theme_status
+
+            if not build_ok:
+                issue_type = (
+                    "SPHINX_STRICT_WARNING_ERROR"
+                    if strict_warnings and sphinx_warning_count > 0
+                    else "SPHINX_BUILD_ERROR"
+                )
+                issues.append(
+                    ValidationIssue(
+                        file_path="sphinx-build",
+                        severity=ValidationSeverity.ERROR,
+                        issue_type=issue_type,
+                        message=f"Sphinx HTML build failed{' (strict warnings mode enabled)' if strict_warnings else ''}.",
+                        context_snippet=output[:600] if output else None,
+                    )
+                )
+
+        err_cnt = sum(1 for i in issues if i.severity == ValidationSeverity.ERROR)
+        warn_cnt = sum(
+            1 for i in issues if i.severity == ValidationSeverity.WARNING
+        ) + (sphinx_warning_count if not strict_warnings else 0)
+
+        return ValidationReport(
+            passed=(err_cnt == 0),
+            total_issues=len(issues),
+            errors_count=err_cnt,
+            warnings_count=warn_cnt,
+            issues=issues,
+            commonmark_parse_successful=cm_parse_ok,
+            structural_validation_successful=struct_ok,
+            sphinx_build_attempted=sphinx_build_attempted,
+            sphinx_build_successful=sphinx_build_successful,
+            sphinx_warning_count=sphinx_warning_count,
+            sphinx_warnings=sphinx_warnings,
+            sphinx_theme_status=sphinx_theme_status,
+            build_output=build_output,
+        )
+
+    def validate_structural_syntax(
+        self, file_path: str, content: str
+    ) -> List[ValidationIssue]:
+        """Parses generated Markdown to ensure CommonMark validity, balanced fences, and clean construct conversion."""
+        issues: List[ValidationIssue] = []
+
+        # 1. Parse via CommonMark engine
+        try:
+            self.md_parser.parse(content)
+        except Exception as e:
+            issues.append(
+                ValidationIssue(
+                    file_path=file_path,
+                    severity=ValidationSeverity.ERROR,
+                    issue_type="PARSER_EXCEPTION",
+                    message=f"CommonMark structural parsing failed: {str(e)}",
+                )
+            )
+            return issues
+
+        # 2. Check for balanced directive and code fences
+        lines = content.splitlines()
+        fence_stack: List[Tuple[int, str, int]] = []
+        re_fence = re.compile(r"^(?P<indent>[ ]{0,3})(?P<char>`|~){3,}")
+
+        for idx, line in enumerate(lines, start=1):
+            m = re_fence.match(line)
+            if m:
+                marker_char = m.group("char")
+                marker_str = m.group(0).strip()
+                length = len(marker_str)
+
+                if (
+                    fence_stack
+                    and fence_stack[-1][1] == marker_char
+                    and length >= fence_stack[-1][2]
+                ):
+                    fence_stack.pop()
+                else:
+                    fence_stack.append((idx, marker_char, length))
+
+        if fence_stack:
+            for unclosed_l, char, length in fence_stack:
+                issues.append(
+                    ValidationIssue(
+                        file_path=file_path,
+                        line_number=unclosed_l,
+                        severity=ValidationSeverity.ERROR,
+                        issue_type="UNCLOSED_FENCE",
+                        message=f"Unclosed code or directive fence of length {length} starting at line {unclosed_l}.",
+                        context_snippet=lines[unclosed_l - 1]
+                        if unclosed_l <= len(lines)
+                        else None,
+                    )
+                )
+
+        # 3. Check for remaining unmigrated MkDocs construct remnants outside code fences
+        re_unmigrated_adm = re.compile(
+            r"^[ ]{0,3}!{3}[ ]+(note|warning|tip|info|danger|caution)"
+        )
+        re_unmigrated_tab = re.compile(r"^[ ]{0,3}={3}[ ]+\"[^\"]+\"")
+
+        in_code = False
+        for idx, line in enumerate(lines, start=1):
+            if re_fence.match(line):
+                in_code = not in_code
+            elif not in_code:
+                if re_unmigrated_adm.match(line):
+                    issues.append(
+                        ValidationIssue(
+                            file_path=file_path,
+                            line_number=idx,
+                            severity=ValidationSeverity.WARNING,
+                            issue_type="UNMIGRATED_ADMONITION",
+                            message=f"Unmigrated MkDocs admonition syntax detected at line {idx}.",
+                            context_snippet=line,
+                        )
+                    )
+                elif re_unmigrated_tab.match(line):
+                    issues.append(
+                        ValidationIssue(
+                            file_path=file_path,
+                            line_number=idx,
+                            severity=ValidationSeverity.WARNING,
+                            issue_type="UNMIGRATED_TAB",
+                            message=f"Unmigrated MkDocs tab syntax detected at line {idx}.",
+                            context_snippet=line,
+                        )
+                    )
+
+        return issues
+
+    def _execute_real_sphinx_build(
+        self, report: ProjectTransformationReport, strict_warnings: bool = False
+    ) -> Tuple[bool, str, List[str], str]:
+        """Runs `sphinx-build` in an isolated sandbox copying docs, assets, and exact conf.py."""
+        with tempfile.TemporaryDirectory() as tmpdir:
+            tmppath = Path(tmpdir)
+            docs_src = tmppath / "source"
+            docs_out = tmppath / "build"
+            docs_src.mkdir(parents=True)
+
+            # Determine the exact common docs_dir prefix from the generated conf.py path
+            conf_prefix_parts: Tuple[str, ...] = ()
+            if report.generated_sphinx_files:
+                conf_key = list(report.generated_sphinx_files.keys())[0]
+                conf_key_path = Path(conf_key)
+                if len(conf_key_path.parts) > 1:
+                    conf_prefix_parts = conf_key_path.parts[:-1]
+
+            # Copy docs static assets, images, examples from docs directory
+            proj_root = Path(report.project_root)
+            docs_dir_name = conf_prefix_parts[0] if conf_prefix_parts else "docs"
+            docs_folder = (
+                proj_root / docs_dir_name
+                if (proj_root / docs_dir_name).is_dir()
+                else (
+                    proj_root / "docs" if (proj_root / "docs").is_dir() else proj_root
+                )
+            )
+            if docs_folder.exists() and docs_folder.is_dir():
+                for item in docs_folder.rglob("*"):
+                    if (
+                        item.is_file()
+                        and not item.name.endswith(".md")
+                        and not item.name.endswith(".pyc")
+                    ):
+                        try:
+                            rel = item.relative_to(docs_folder)
+                            if any(
+                                part
+                                in (
+                                    ".git",
+                                    ".venv",
+                                    "venv",
+                                    "__pycache__",
+                                    ".pytest_cache",
+                                    "site",
+                                )
+                                for part in rel.parts
+                            ):
+                                continue
+                            dest_asset = docs_src / rel
+                            dest_asset.parent.mkdir(parents=True, exist_ok=True)
+                            shutil.copy2(item, dest_asset)
+                        except Exception:
+                            pass
+
+            # Write transformed markdown documents directly into docs_src relative to the docs_dir
+            for doc in report.transformed_documents:
+                doc_path = Path(doc.target_file)
+                if (
+                    conf_prefix_parts
+                    and doc_path.parts[: len(conf_prefix_parts)] == conf_prefix_parts
+                ):
+                    sub_path = Path(*doc_path.parts[len(conf_prefix_parts) :])
+                elif len(doc_path.parts) > 1 and doc_path.parts[0] in ("docs", "doc"):
+                    sub_path = Path(*doc_path.parts[1:])
+                else:
+                    sub_path = doc_path
+
+                dest_file = docs_src / sub_path
+                dest_file.parent.mkdir(parents=True, exist_ok=True)
+                dest_file.write_text(doc.transformed_content, encoding="utf-8")
+
+            # Check theme availability and place conf.py directly at docs_src / conf.py
+            theme_status = "INSTALLED"
+            for conf_path_str, conf_code in report.generated_sphinx_files.items():
+                conf_dest = docs_src / "conf.py"
+                conf_dest.parent.mkdir(parents=True, exist_ok=True)
+
+                final_conf = conf_code
+                theme_match = re.search(
+                    r"html_theme\s*=\s*['\"]([^'\"]+)['\"]", conf_code
+                )
+                if theme_match:
+                    target_theme = theme_match.group(1)
+                    if target_theme not in (
+                        "alabaster",
+                        "default",
+                        "classic",
+                        "sphinxdoc",
+                        "scrolls",
+                        "agogo",
+                        "traditional",
+                        "nature",
+                        "haiku",
+                        "pyramid",
+                        "bizstyle",
+                    ):
+                        theme_mod = target_theme.replace("-", "_")
+                        if importlib.util.find_spec(theme_mod) is None:
+                            theme_status = f"THEME_UNAVAILABLE:{target_theme}"
+                            fallback_theme = (
+                                "furo"
+                                if importlib.util.find_spec("furo") is not None
+                                else "alabaster"
+                            )
+                            final_conf = re.sub(
+                                r"html_theme\s*=\s*['\"][^'\"]+['\"]",
+                                f'html_theme = "{fallback_theme}"',
+                                final_conf,
+                            )
+                            final_conf = final_conf.replace(
+                                f'"{theme_mod}",', ""
+                            ).replace(f"'{theme_mod}',", "")
+
+                # Ensure sphinx_immaterial disables remote Google font downloads in sandbox builds
+                if "sphinx_immaterial" in final_conf:
+                    if "html_theme_options" in final_conf:
+                        if (
+                            "'font': False" not in final_conf
+                            and '"font": False' not in final_conf
+                        ):
+                            final_conf = re.sub(
+                                r"html_theme_options\s*=\s*\{",
+                                "html_theme_options = {'font': False, ",
+                                final_conf,
+                                count=1,
+                            )
+                    else:
+                        final_conf += "\nhtml_theme_options = {'font': False}\n"
+
+                conf_dest.write_text(final_conf, encoding="utf-8")
+
+            # Execute real sphinx.cmd.build
+            cmd = [sys.executable, "-m", "sphinx.cmd.build", "-b", "html"]
+            if strict_warnings:
+                cmd.append("-W")
+            cmd.extend([str(docs_src), str(docs_out)])
+
+            try:
+                proc = subprocess.run(
+                    cmd,
+                    capture_output=True,
+                    text=True,
+                    stdin=subprocess.DEVNULL,
+                )
+                combined_output = f"STDOUT:\n{proc.stdout}\nSTDERR:\n{proc.stderr}"
+
+                # Parse stderr/stdout for Sphinx warnings
+                warnings: List[str] = []
+                for line in (proc.stdout + "\n" + proc.stderr).splitlines():
+                    if "WARNING:" in line or "warning:" in line.lower():
+                        if line.strip() not in warnings:
+                            warnings.append(line.strip())
+
+                if proc.returncode == 0:
+                    return True, combined_output, warnings, theme_status
+                else:
+                    return False, combined_output, warnings, theme_status
+            except Exception as ex:
+                return False, f"Sphinx execution error: {str(ex)}", [], theme_status

sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/METADATA

@@ -0,0 +1,199 @@
+Metadata-Version: 2.5
+Name: sphinx-mkdocs-migrate
+Version: 0.0.1.dev0
+Summary: Deterministic, evidence-driven analyzer and migration engine from MkDocs to Sphinx + MyST
+Project-URL: Homepage, https://github.com/prateek-dagar/sphinx-mkdocs-migrate
+Project-URL: Documentation, https://github.com/prateek-dagar/sphinx-mkdocs-migrate#readme
+Project-URL: Repository, https://github.com/prateek-dagar/sphinx-mkdocs-migrate.git
+Project-URL: Issues, https://github.com/prateek-dagar/sphinx-mkdocs-migrate/issues
+Project-URL: Changelog, https://github.com/prateek-dagar/sphinx-mkdocs-migrate/blob/main/CHANGELOG.md
+Author-email: Prateek Dagar <prateek0508dagar@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: autodoc,docs-migration,documentation-converter,material-for-mkdocs,migrate-mkdocs-to-sphinx,migration,mkdocs,mkdocs-to-sphinx,myst-parser,sphinx,sphinx-design,sphinx-to-mkdocs
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+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
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: click>=8.1
+Requires-Dist: markdown-it-py>=3.0.0
+Requires-Dist: mdit-py-plugins>=0.4.0
+Requires-Dist: myst-parser>=2.0.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: sphinx>=7.0.0
+Requires-Dist: tomli>=2.0.0; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: furo>=2024.1.0; extra == 'dev'
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'dev'
+Requires-Dist: sphinx-design>=0.5.0; extra == 'dev'
+Requires-Dist: sphinx-immaterial>=0.11.0; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == 'dev'
+Requires-Dist: sphinxcontrib-mermaid>=0.9.0; extra == 'dev'
+Requires-Dist: twine>=4.0.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2024.1.0; extra == 'docs'
+Requires-Dist: myst-parser>=2.0.0; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'docs'
+Requires-Dist: sphinx-design>=0.5.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0.0; extra == 'docs'
+Provides-Extra: research
+Requires-Dist: beautifulsoup4>=4.12.0; extra == 'research'
+Requires-Dist: mkdocs-literate-nav>=0.6.0; extra == 'research'
+Requires-Dist: mkdocs-material>=9.5.0; extra == 'research'
+Requires-Dist: mkdocs>=1.5.0; extra == 'research'
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == 'research'
+Provides-Extra: test
+Requires-Dist: furo>=2024.1.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.0; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'test'
+Requires-Dist: sphinx-design>=0.5.0; extra == 'test'
+Requires-Dist: sphinx-immaterial>=0.11.0; extra == 'test'
+Requires-Dist: sphinx-rtd-theme>=2.0.0; extra == 'test'
+Requires-Dist: sphinxcontrib-mermaid>=0.9.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# sphinx_mkdocs_migrate
+
+[![PyPI version](https://img.shields.io/badge/pypi-0.0.1.dev0-blue.svg)](https://pypi.org/project/sphinx-mkdocs-migrate/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+**`sphinx-mkdocs-migrate`** (`sphinx-migrate`) is a deterministic, evidence-driven analyzer and migration engine that safely converts MkDocs and Material for MkDocs documentation projects to Sphinx + MyST Parser.
+
+---
+
+## Key Principles & Design Boundaries
+
+### What `sphinx-migrate` Does
+* **Evidence-Driven Subsystem Analysis**: Inspects `mkdocs.yml`, directory structures, theme features, Markdown extensions, and plugins.
+* **Deterministic, Read-Only Planning**: Generates a canonical `MigrationPlan` with stable hashes and provenance tracking for every extension and package.
+* **Byte-Preserving Transformation**: Transforms only specific non-standard syntax spans (e.g. tabs, dropdowns, includes) into native MyST/Sphinx directives while guaranteeing byte-for-byte identity on untouched Markdown.
+* **AST-Guided API Migration**: Resolves Python symbols statically (`ast.parse`) without executing untrusted repository code. Conservative manual boundary for re-exports and ambiguities.
+* **Dual Validation Engine**: Performs structural Markdown AST validation and real isolated Sphinx HTML builds in an isolated sandbox.
+
+### What `sphinx-migrate` Does NOT Do
+* **No Speculative Heuristics**: If a syntax construct or custom plugin cannot be deterministically mapped, it is routed to `MANUAL` or `UNSUPPORTED` rather than guessed.
+* **No Source Code Mutation**: Does not rewrite Python `.py` source code or docstrings.
+* **Source-Faithful Theme Mapping**: Material for MkDocs maps to `sphinx_immaterial`; the planned target theme and its package are preserved in generated `conf.py` rather than being silently replaced during validation.
+* **Build Success != Runtime Equivalence**: A successful Sphinx build proves structural and buildability correctness; it does not guarantee visual or JavaScript runtime identity with MkDocs Material.
+
+---
+
+## Installation
+
+```bash
+pip install sphinx-mkdocs-migrate
+```
+
+---
+
+## CLI Workflow
+
+The migration lifecycle consists of 4 distinct commands:
+
+```text
+sphinx-migrate analyze   # 1. Factual project & subsystem inspection
+       ↑
+sphinx-migrate plan      # 2. Deterministic, read-only MigrationPlan generation
+       ⊑
+sphinx-migrate migrate   # 3. Dry-run diffing or atomic disk transformation
+       ⊑
+sphinx-migrate validate  # 4. AST validation & isolated sandbox Sphinx build
+```
+
+### 1. Project Inspection (`analyze`)
+```bash
+sphinx-migrate analyze path/to/project
+# Machine-readable JSON output:
+sphinx-migrate analyze path/to/project --json-output
+```
+
+### 2. Migration Planning(`plan`)
+```bash
+# Human-readable summary with Rich tables:
+sphinx-migrate plan path/to/project
+
+# Export canonical plan JSON:
+sphinx-migrate plan path/to/project --output-json plan.json
+```
+
+### 3. Transformation & Scaffolding (`migrate`)
+```bash
+# Dry-run with unified diff preview (no disk mutations):
+sphinx-migrate migrate path/to/project --diff
+
+# Apply changes to disk and scaffold conf.py:
+sphinx-migrate migrate path/to/project --apply
+
+# Overwrite conflicting existing conf.py:
+sphinx-migrate migrate path/to/project --apply --force-conf
+```
+
+### 4. Build Validation(`validate`)
+```bash
+# Full isolated sandbox Sphinx build:
+sphinx-migrate validate path/to/project --build
+
+# Strict mode (fail on any Sphinx warnings):
+sphinx-migrate validate path/to/project --build --strict
+```
+
+---
+
+## Supported Feature Policies
+
+| Source Feature | Category | Action | Target / Resolution | Provenance |
+| :--- | :--- | :--- | :--- | :--- |
+| `content.code.copy` | `THEME_FEATURE` | `ENABLE_EXTENSION` | `sphinx_copybutton` / `sphinx-copybutton>=0.5.2` | `FEATURE_POLICY` |
+| `content.tabs.link` | `THEME_FEATURE` | `ENABLE_EXTENSION` | `sphinx_design` / `sphinx-design>=0.5.0` | `FEATURE_POLICY` |
+| `pymdownx.tabbed` | `MARKDOWN_EXTENSION` | `TRANSFORM` | `sphinx-design` (`{tab-set}`, `{tab-item}`) | `EXTENSION_POLICY` |
+| `pymdownx.details` | `MARKDOWN_EXTENSION` | `TRANSFORM` | `sphinx-design` (`{dropdown}`) | `EXTENSION_POLICY` |
+| `pymdownx.superfences` | `MARKDOWN_EXTENSION` | `PRESERVE` | MyST `colon_fence` | `EXTENSION_POLICY` |
+| `pymdownx.arithmatex` | `MARKDOWN_EXTENSION` | `PRESERVE` | MyST `dollarmath` | `EXTENSION_POLICY` |
+| `pymdownx.snippets` | `MARKDOWN_EXTENSION` | `TRANSFORM` | MyST `{include}` / `literalinclude` | `EXTENSION_POLICY` |
+| `pymdownx.emoji` | `MARKDOWN_EXTENSION` | `MANUAL` | Manual review of icon shortcodes (`:smile:`) | `MANUAL` |
+| `mkdocstrings` | `PLUGIN` | `TRANSFORM` | `sphinx.ext.autodoc` + `sphinx.ext.napoleon` | `EXTENSION_POLICY` |
+| `search.share` | `THEME_FEATURE` | `UNSUPPORTED` | No static Sphinx HTML equivalent | `UNSUPPORTED` |
+
+---
+
+## Roadmap & Future Evolution
+
+While `sphinx-mkdocs-migrate` is currently focused on high-fidelity migration from **MkDocs to Sphinx + MyST**, our planned roadmap includes full bi-directional support:
+
+* **Phase 1 (Current)**: Full-fidelity MkDocs & Material for MkDocs ➔ Sphinx + MyST migration with 100% AST byte preservation.
+* **Phase 2 (Bi-Directional)**: Reverse migration (Sphinx + MyST ➔ MkDocs + Material).
+
+See our full [**Roadmap Document**](docs/roadmap.md) for details.
+
+---
+
+## Contributors
+
+Thank you to everyone who has contributed to `sphinx-mkdocs-migrate`!
+
+Please see our [**Contributors List**](docs/contributors.md) for the full list of contributors.
+
+---
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE).

sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/RECORD

@@ -0,0 +1,39 @@
+sphinx_mkdocs_migrate/__init__.py,sha256=MpLDqUT1PRCFuYshJr4clFj6NeunxUW3_f2saFEUr-w,216
+sphinx_mkdocs_migrate/cli.py,sha256=u-e6SNR6B5Wn9Osif-Jcp1of8bthL8uimThohs3Qke0,17323
+sphinx_mkdocs_migrate/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+sphinx_mkdocs_migrate/analyzer/__init__.py,sha256=seGfJc-jcM1H4nnpTmVH02zVr2TCYYWhluKG2RKnOIM,323
+sphinx_mkdocs_migrate/analyzer/ci.py,sha256=GDM9t_CrqMZ6rrvxNHtFXYYqsElt1C972uoLO_4Fg8g,8968
+sphinx_mkdocs_migrate/analyzer/dependencies.py,sha256=EgCXxgogphsT5Wv4aLBQiCtr9tU9r22KfogyJxbi5c0,5173
+sphinx_mkdocs_migrate/analyzer/markdown.py,sha256=Yj8u6uGwg7xfDypZ7YJuyCnqkgLHXP1Y8zjc9qhUmhA,6179
+sphinx_mkdocs_migrate/analyzer/mkdocs.py,sha256=T62dcO9XQYxUlEyt_GVv10jnj5cZK3EOamigt_68Jy4,9943
+sphinx_mkdocs_migrate/analyzer/models.py,sha256=urAJupWS-Uamj1c8AW_DqzP3urSvIgCH_Wz0Ps-Vh9o,12464
+sphinx_mkdocs_migrate/analyzer/navigation.py,sha256=99epSvLaDKQ7hWq6Ag7eK65cFa5AUeLWwmANG_BNUKo,4314
+sphinx_mkdocs_migrate/analyzer/project.py,sha256=4W2rLR6D9nu--XhUy7_40zOkngTWkmBb3tBP1ReX60M,21076
+sphinx_mkdocs_migrate/parsing/doc_ir.py,sha256=AZYE5SFspjRdKA4a0VS1rtbuWiPEnaDMf1HaoDEbs5o,17352
+sphinx_mkdocs_migrate/parsing/flow_extractor.py,sha256=UA45aNf82Pb8onARz2ZxZwSUKCEYtpcPpCWNPG7QaHA,17546
+sphinx_mkdocs_migrate/parsing/html_flow_parser.py,sha256=WYklciWISSZmsmS9UaiiY9Tx6nM_wZ6v8o6wE_QDBTc,13873
+sphinx_mkdocs_migrate/parsing/markdown.py,sha256=PIrPcgW2E-CxdODA_pKTHsE-_DYJuwusdTLuF-OKgHg,894
+sphinx_mkdocs_migrate/parsing/markdown_ir.py,sha256=VDWS57AkgXhNwEjyROlIzrZABSm76iq2c-c6U85tPK8,1401
+sphinx_mkdocs_migrate/parsing/markdown_it_adapter.py,sha256=syY17CPKVlNHNFq28rp8kAW0Ya-pVeap1uKQuSSzPu0,18634
+sphinx_mkdocs_migrate/parsing/requirements.py,sha256=bTYBr6JgZe3hddqp6CVrNQC5SoXGzHadYrtySzhLKQU,5760
+sphinx_mkdocs_migrate/planner/accountability.py,sha256=aWPRMGI9Ukaft-FIXFx6rL2M7m-q0vJIqcJ9QsLoWDk,3988
+sphinx_mkdocs_migrate/planner/ci.py,sha256=QNFDi_l4XE9wbTfQDyOKnDZ2mjVptXRyZLe7kGrtz34,4748
+sphinx_mkdocs_migrate/planner/conf_builder.py,sha256=pkloyO9mdKJz4yBDsZtKotStmNlRTPj5Hd9N7zQiH54,6578
+sphinx_mkdocs_migrate/planner/models.py,sha256=NEnZB715M6EQKZ7oj5n4fzz8aCkotBxVL5WFy3Gsq9A,13941
+sphinx_mkdocs_migrate/planner/planner.py,sha256=DYNsWsC4QfLem4HkWFdF48OjEd7bBN6eGe2H9EbxMdI,92813
+sphinx_mkdocs_migrate/planner/policy.py,sha256=U124mG_j_IB3xkzsNa2vb4Cxj_dsfBlvlrfQW-KP-mc,22560
+sphinx_mkdocs_migrate/planner/theme_constants.py,sha256=upcmeE-FH63egv6LwPLh7i7QmnfUaVXm3CbE9B2sgzE,1982
+sphinx_mkdocs_migrate/planner/toctree.py,sha256=jhDBT-DrQCcXRINUNMq8P6_IvJZCWGXcVI5JkWxid3I,5716
+sphinx_mkdocs_migrate/rules/catalog.py,sha256=BqBthi-5DEpIbjEohxqqA_J_HgrWc7Zwn5p7qIiJQbc,6198
+sphinx_mkdocs_migrate/rules/engine.py,sha256=Vftivico84LrDZoaHKFuv0mpWMSv4wLtlJwQxjgldug,4109
+sphinx_mkdocs_migrate/rules/models.py,sha256=MDwSU1Ftrj-deEmPBpPFUqtxkhcI4nod0BzF32zKnM4,7329
+sphinx_mkdocs_migrate/transformer/engine.py,sha256=4i-kx2-v5WYdrBxFcNmhaHfJXMTGt818fuYQnsUM5Rw,38395
+sphinx_mkdocs_migrate/transformer/models.py,sha256=_xylL6K_-dMwWSRBEGI6iNv98SXFRtBuNbeassVByGk,2250
+sphinx_mkdocs_migrate/transformer/myst_transformer.py,sha256=n7Urmr7dOV88ywM3qDHea0FQF-t2Pge5AyQ4BGUvD4I,16877
+sphinx_mkdocs_migrate/validator/models.py,sha256=xh1naNTGxmS0rA9E02kZIJVZ7iM0J_pHdr180-qef4w,1343
+sphinx_mkdocs_migrate/validator/verifier.py,sha256=Jz_WES35e_4yfGV-xX9mpzuUIEv980SCU7Y-bdOVecc,16194
+sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/METADATA,sha256=eKadiVEdVgSk5PD7mjHJJIDYepfkHyFydlufL4sD8W4,9292
+sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/entry_points.txt,sha256=43-CEf6s0mYtlEQxDTiyvVP8LM7A7vA6tOYa4Wmug3E,66
+sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/licenses/LICENSE,sha256=-zktRvqvi5gL9u7v9C-oK6Aosz8lCx-7X-1NyINhiBM,11343
+sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/RECORD,,

sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/WHEEL

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

sphinx_mkdocs_migrate-0.0.1.dev0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sphinx-migrate = sphinx_mkdocs_migrate.cli:main