diff --git a/docs/requirements-insiders.txt b/docs/requirements-insiders.txt index c221efd4b..afdf050c1 100644 --- a/docs/requirements-insiders.txt +++ b/docs/requirements-insiders.txt @@ -4,6 +4,10 @@ babel==2.15.0 # via # mkdocs-git-revision-date-localized-plugin # mkdocs-material +beautifulsoup4==4.13.4 + # via + # markdownify + # mkdocs-llmstxt black==23.10.0 # via -r docs/requirements.in certifi==2024.7.4 @@ -43,17 +47,20 @@ markdown-it-py==3.0.0 # mdformat # mdformat-gfm # mdit-py-plugins +markdownify==1.1.0 + # via mkdocs-llmstxt markupsafe==2.1.5 # via # jinja2 # mkdocs -mdformat==0.7.17 +mdformat==0.7.22 # via # -r docs/requirements.in # mdformat-admon # mdformat-gfm # mdformat-mkdocs # mdformat-tables + # mkdocs-llmstxt mdformat-admon==2.0.2 # via # -r docs/requirements.in @@ -82,6 +89,8 @@ mkdocs==1.5.0 # mkdocs-redirects mkdocs-git-revision-date-localized-plugin==1.3.0 # via -r docs/requirements.in +mkdocs-llmstxt==0.2.0 + # via -r docs/requirements.in mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4 # via # -r docs/requirements-insiders.in @@ -128,9 +137,15 @@ regex==2022.10.31 requests==2.32.3 # via mkdocs-material six==1.16.0 - # via python-dateutil + # via + # markdownify + # python-dateutil smmap==5.0.2 # via gitdb +soupsieve==2.7 + # via beautifulsoup4 +typing-extensions==4.14.0 + # via beautifulsoup4 uc-micro-py==1.0.3 # via linkify-it-py urllib3==2.2.2 diff --git a/docs/requirements.in b/docs/requirements.in index 5f504e015..3cc0f6a25 100644 --- a/docs/requirements.in +++ b/docs/requirements.in @@ -7,3 +7,4 @@ mdformat-mkdocs>=2.0.4 mdformat-admon>=2.0.2 mkdocs-redirects>=1.2.2 mkdocs-git-revision-date-localized-plugin>=1.3.0 +mkdocs-llmstxt>=0.2.0 diff --git a/docs/requirements.txt b/docs/requirements.txt index 6392a30a5..41c93098a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,6 +4,10 @@ babel==2.15.0 # via # mkdocs-git-revision-date-localized-plugin # mkdocs-material +beautifulsoup4==4.13.4 + # via + # markdownify + # mkdocs-llmstxt black==24.4.2 # via -r docs/requirements.in certifi==2024.7.4 @@ -43,17 +47,20 @@ markdown-it-py==3.0.0 # mdformat # mdformat-gfm # mdit-py-plugins +markdownify==1.1.0 + # via mkdocs-llmstxt markupsafe==2.1.5 # via # jinja2 # mkdocs -mdformat==0.7.17 +mdformat==0.7.22 # via # -r docs/requirements.in # mdformat-admon # mdformat-gfm # mdformat-mkdocs # mdformat-tables + # mkdocs-llmstxt mdformat-admon==2.0.6 # via # -r docs/requirements.in @@ -85,6 +92,8 @@ mkdocs-get-deps==0.2.0 # via mkdocs mkdocs-git-revision-date-localized-plugin==1.3.0 # via -r docs/requirements.in +mkdocs-llmstxt==0.2.0 + # via -r docs/requirements.in mkdocs-material==9.5.29 # via -r docs/requirements.in mkdocs-material-extensions==1.3.1 @@ -130,9 +139,15 @@ regex==2024.5.15 requests==2.32.3 # via mkdocs-material six==1.16.0 - # via python-dateutil + # via + # markdownify + # python-dateutil smmap==5.0.2 # via gitdb +soupsieve==2.7 + # via beautifulsoup4 +typing-extensions==4.14.0 + # via beautifulsoup4 uc-micro-py==1.0.3 # via linkify-it-py urllib3==2.2.2 diff --git a/mkdocs.template.yml b/mkdocs.template.yml index 9a4d3b1cb..0b2ee6623 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -40,6 +40,7 @@ repo_name: uv site_author: charliermarsh site_url: https://docs.astral.sh/uv/ site_dir: site/uv +site_description: uv is an extremely fast Python package and project manager, written in Rust. markdown_extensions: - admonition - pymdownx.details @@ -80,6 +81,68 @@ plugins: "configuration/files.md": "concepts/configuration-files.md" "configuration/indexes.md": "concepts/indexes.md" "configuration/environment.md": "reference/environment.md" + - llmstxt: + markdown_description: | + You can use uv to install Python dependencies, run scripts, manage virtual environments, + build and publish packages, and even install Python itself. uv is capable of replacing + `pip`, `pip-tools`, `pipx`, `poetry`, `pyenv`, `twine`, `virtualenv`, and more. + + uv includes both a pip-compatible CLI (prepend `uv` to a pip command, e.g., `uv pip install ruff`) + and a first-class project interface (e.g., `uv add ruff`) complete with lockfiles and + workspace support. + sections: + Getting started: + - getting-started/installation.md + - getting-started/first-steps.md + - getting-started/features.md + Guides: + - guides/install-python.md + - guides/scripts.md + - guides/tools.md + - guides/projects.md + - guides/package.md + Integrations: + - guides/integration/docker.md + - guides/integration/jupyter.md + - guides/integration/marimo.md + - guides/integration/github.md + - guides/integration/gitlab.md + - guides/integration/pre-commit.md + - guides/integration/pytorch.md + - guides/integration/fastapi.md + - guides/integration/alternative-indexes.md + - guides/integration/dependency-bots.md + - guides/integration/aws-lambda.md + Projects: + - concepts/projects/layout.md + - concepts/projects/init.md + - concepts/projects/dependencies.md + - concepts/projects/run.md + - concepts/projects/sync.md + - concepts/projects/config.md + - concepts/projects/build.md + - concepts/projects/workspaces.md + Features: + - concepts/tools.md + - concepts/python-versions.md + - concepts/configuration-files.md + - concepts/indexes.md + - concepts/resolution.md + - concepts/build-backend.md + - concepts/authentication.md + - concepts/cache.md + The pip interface: + - pip/environments.md + - pip/packages.md + - pip/inspection.md + - pip/dependencies.md + - pip/compile.md + - pip/compatibility.md + Reference: + - reference/cli.md + - reference/settings.md + - reference/environment.md + - reference/installer.md extra_css: - stylesheets/extra.css extra_javascript: