sphinx-mkdocs-migrate 0.0.1.dev0__tar.gz

sphinx_mkdocs_migrate-0.0.1.dev0/.gitignore

@@ -0,0 +1,35 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+.eggs/
+
+# Virtual Environments
+venv/
+.venv/
+env/
+ENV/
+
+# Testing & Coverage
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Temporary / Scratch Files
+scratch/
+.system_generated/
+*.log
+.env*
+
+# IDE & OS
+.DS_Store
+.idea/
+.vscode/
+docs/_build/
+research/
+scratch/

sphinx_mkdocs_migrate-0.0.1.dev0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Prateek Dagar
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sphinx_mkdocs_migrate-0.0.1.dev0/MIGRATION_GUIDE.md

@@ -0,0 +1,78 @@
+# sphinx-migrate Migration Guide
+
+This guide explains how `sphinx-migrate` converts MkDocs and Material for MkDocs projects into modern Sphinx + MyST Parser documentation suites, and outlines the deliberate boundaries between automated transformation, source preservation, and manual developer review.
+
+---
+
+## 1. Core Concepts & Equivalences
+
+| MkDocs / Material Concept | Sphinx + MyST Equivalent | Automation Status |
+| :--- | :--- | :--- |
+| `mkdocs.yml` (Configuration) | `docs/conf.py` (Sphinx config) | Automated (new) / Preserved (if existing conflict) |
+| `nav:` hierarchy | `{toctree}` directives in `index.md` | Automated (deterministic, order-preserving) |
+| Tabs (`pymdownx.tabbed`) | `{tab-set}` & `{tab-item}` (sphinx-design) | Automated (byte-preserving transformation) |
+| Dropdowns (`pymdownx.details`) | `{dropdown}` (sphinx-design) | Automated (byte-preserving transformation) |
+| Nested fences (`pymdownx.superfences`) | MyST 4+ backticks or `:::` colon_fence | Automated / Native MyST |
+| Math (`pymdownx.arithmatex`) | MyST `dollarmath` extension | Automated config enablement |
+| File snippets (`pymdownx.snippets`) | MyST `{include}` / `literalinclude` | Document transformation required |
+| API Reference (`mkdocstrings`) | `sphinx.ext.autodoc` + `sphinx.ext.napoleon` | Static AST resolved (see Section 3) |
+
+---
+
+## 2. Theme Migration Policy
+
+The migration engine explicitly separates theme selection from feature-level dependency derivation:
+* **Material for MkDocs** maps to `sphinx_immaterial` together with its planned package and theme options. Build and validation paths must use that plan; they must not silently substitute another theme.
+* **ReadTheDocs / MkDocs default** maps to `sphinx_rtd_theme`.
+* **Custom Themes** route to `MANUAL` review.
+
+Features (such as `content.code.copy`) are derived independently via the Declarative Policy Engine (e.g. `sphinx-copybutton`) if and only if explicitly present in the source config.
+
+---
+
+## 3. API Documentation & Static Symbol Resolution
+
+Mkdocstrings directives (`::: package.module.Symbol`) are analyzed statically using Python AST inspection (zero untrusted code execution):
+
+1. **MODULE, CLASS, FUNCTION, METHOD, ATTRIBUTE** (`STATICALLY_RESOLVED`):
+   * Maps to Sphinx directive candidates:
+     * `MODULE`    -> `automodule`
+     * `CLASS`     -> `autoclass`
+     * `FUNCTION`  -> `autofunction`
+     * `METHOD`    -> `automethod`
+     * `ATTRIBUTE` -> `autodata`
+2. **REEXPORT, AMBIGUOUS, UNRESOLVED**:
+   * Routes conservatively to `MANUAL` review. Source Markdown constructs are preserved byte-for-byte without speculative mutations.
+
+---
+
+## 4. Manual Review Items
+
+Every manual review item generated in `plan.json` and CLI output explicitly answers:
+1. **WHAT** was detected;
+2. **WHERE** it was detected;
+3. **WHY** it cannot be automated;
+4. **WHAT REMEDIATION** is required;
+5. **WHAT SOURCE** was preserved byte-for-byte.
+
+---
+
+## 5. Build Pipelines, Obsolete Scripts, & Dependency Groups
+
+### 5.1 Generator Script Lifecycle (`mkdocs-gen-files`)
+In MkDocs projects, API reference pages and navigation structures were often generated dynamically at build time using the `gen-files` plugin and a script such as `scripts/gen_ref_nav.py`:
+- **MkDocs Paradigm**: Relied on runtime generation of in-memory virtual files via `import mkdocs_gen_files` and `mkdocs_gen_files.open(...)`.
+- **Sphinx Paradigm**: Sphinx natively builds from persistent filesystem documents using `sphinx.ext.autodoc` and `autosummary`. The migration planner analyzes generator scripts via AST and directly synthesizes deterministic, checked-in MyST markdown files in `docs/reference/`.
+- **Post-Migration Cleanup**: Because `mkdocs-gen-files` is removed from project dependencies during migration, generator scripts importing it become broken dead code. The migration engine automatically deletes obsolete generator scripts declared in `mkdocs.yml` (and their enclosing directory if left empty) during `--apply`.
+- **Single-Stage Build**: In `tox.ini` and CI workflows, the build command requires only the single standard command:
+  ```ini
+  commands =
+      sphinx-build -b html docs site/_build/html
+  ```
+  No preceding `python scripts/...` execution step is needed or valid.
+
+### 5.2 Dynamic Dependency Group & Extras Resolution
+When configuring `[testenv:docs]` in `tox.ini`, the migration engine detects where documentation packages reside in the source project:
+- **PEP 735 (`[dependency-groups]`)**: If dependencies were in a group (e.g. `docs`, `dev`, `documentation`), tox is configured with `dependency_groups = <group_name>`.
+- **PEP 621 (`[project.optional-dependencies]`)**: If dependencies were declared as package extras (e.g. `[project.optional-dependencies] docs`), tox is configured with `extras = <extra_name>`.
+- **Pip Requirements**: If dependencies are tracked via `docs/requirements.txt` or `requirements.txt`, tox is configured with `deps = -r <file_path>`.

sphinx_mkdocs_migrate-0.0.1.dev0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,126 @@
+# 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).