Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/codeql.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ "javascript-typescript", "python" ]
language: [ "python" ]
steps:
- uses: actions/checkout@v5
with:
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ site_name: rats
repo_url: "https://github.com/microsoft/rats"
repo_name: "rats"
docs_dir: "docs"
site_dir: "rats-devtools/dist/site"
theme:
name: material
logo: images/logo.png
Expand Down
2 changes: 1 addition & 1 deletion rats-apps/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]
name = "rats-apps"
description = "research analysis tools for building applications"
version = "0.14.2"
version = "0.15.0"
readme = "README.md"
requires-python = ">=3.10,<4.0"
authors = [
Expand Down
2 changes: 1 addition & 1 deletion rats-apps/uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 10 additions & 11 deletions rats-devtools/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]
name = "rats-devtools"
description = "Rats Development Tools"
version = "0.14.2"
version = "0.15.0"
readme = "README.md"
requires-python = ">=3.10,<4.0"
authors = [
Expand All @@ -15,19 +15,9 @@ dependencies = [
"rats-apps",
"click",
"toml",
"twine",
# workflowing
"azure-ai-ml",
"azure-identity",
# documentation tooling
"mkdocs",
"mkdocs-awesome-pages-plugin",
"mkdocs-material",
"mkdocs-video",
"mkdocs-glightbox",
"mdx-truly-sane-lists",
"mkdocstrings",
"mkdocstrings-python",
]

[project.urls]
Expand All @@ -43,6 +33,15 @@ dev = [
"pytest-nunit",
"setuptools",
"ruff",
# documentation tooling
"mkdocs",
"mkdocs-awesome-pages-plugin",
"mkdocs-material",
"mkdocs-video",
"mkdocs-glightbox",
"mdx-truly-sane-lists",
"mkdocstrings",
"mkdocstrings-python",
]

[build-system]
Expand Down
25 changes: 20 additions & 5 deletions rats-devtools/src/rats/docs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,26 @@
accomplish this as a small command proxy that inserts default arguments to the underlying `mkdocs`
command.

!!! note
Previously, this module would copy original markdown files, and symlink directories during the
build process to unify the docs across components. However, over time, we've found solutions
that eliminate these custom operations, making the `rats-docs` commands much simpler, and
making it easy to get the same output when using `mkdocs` commands directly.
## Dependencies

We don't define the `mkdocs` dependencies as part of our library because we expect you to choose
them based on your configured `mkdocs.yaml` file. This means that the `rats-docs` commands will
fail until you've added the needed dependencies to your `pyproject.toml`. If using a tool like
`uv`, they might look something like the ones below:

```toml
[dependency-groups]
dev = [
"mkdocs",
"mkdocs-awesome-pages-plugin",
"mkdocs-material",
"mkdocs-video",
"mkdocs-glightbox",
"mdx-truly-sane-lists",
"mkdocstrings",
"mkdocstrings-python",
]
```

## Structure

Expand Down
280 changes: 16 additions & 264 deletions rats-devtools/uv.lock

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion rats/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[project]
name = "rats"
description = "bundled research analysis tools"
version = "0.14.2"
version = "0.15.0"
readme = "README.md"
requires-python = ">=3.10,<4.0"
authors = [
Expand Down
899 changes: 10 additions & 889 deletions rats/uv.lock

Large diffs are not rendered by default.

Loading