Skip to content

BF: Resolve path to tools correctly. #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arokem merged 3 commits into from
Sep 17, 2026
Merged

BF: Resolve path to tools correctly. #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08438a8
BF: Resolve path to tools correctly.
arokem Sep 11, 2026
40d28ae
Move the tools folder, with the update_switcher into trx.
arokem Sep 16, 2026
5307cc6
Do not document tools and include as package data.
arokem Sep 17, 2026
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
4 changes: 2 additions & 2 deletions .github/workflows/docbuild.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ jobs:
- name: Update switcher.json with new version
id: switcher
run: |
python tools/update_switcher.py gh-pages-out/switcher.json \
python trx/tools/update_switcher.py gh-pages-out/switcher.json \
--version "${{ steps.get_version.outputs.VERSION }}" \
--github-output "$GITHUB_OUTPUT"
- name: Deploy all release docs in a single push
Expand Down Expand Up @@ -160,7 +160,7 @@ jobs:
esac
done
echo "Rebuilding switcher from:$args"
python tools/update_switcher.py gh-pages-out/switcher.json --rebuild $args
python trx/tools/update_switcher.py gh-pages-out/switcher.json --rebuild $args
- name: Commit and push switcher.json
run: |
cd gh-pages-out
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@

autoapi_type = 'python'
autoapi_dirs = ['../../trx']
autoapi_ignore = ['*test*', '*version*']
autoapi_ignore = ['*test*', '*version*', '*tools*']


def _validate_reference_urls(urls, timeout=5):
Expand Down
6 changes: 5 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ dependencies = [

[project.optional-dependencies]
utils = [
"dipy",
"dipy >= 1.12",
"fury >= 0.10.0, < 2.0.0"

@skoudoro skoudoro Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add

[tool.setuptools.package-data]
trx = ["tools/*.py"]

and also 'tools' to autoapi_ignore. to avoid to see this in the API.

Also, to remove from codecov ( trx/tools/*). because it decrease it for no reason

]
dev = [
Expand Down Expand Up @@ -92,6 +92,10 @@ trx_info = "trx.cli:info_cmd"
packages = ["trx"]
include-package-data = true

[tool.setuptools.package-data]
trx = ["tools/*.py"]


[tool.setuptools_scm]
write_to = "trx/_version.py"
fallback_version = "0.0"
Expand Down
2 changes: 1 addition & 1 deletion trx/tests/test_update_switcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

import pytest

TOOLS_DIR = Path(__file__).resolve().parents[2] / "tools"
TOOLS_DIR = Path(__file__).resolve().parent.parent / "tools"
SCRIPT = TOOLS_DIR / "update_switcher.py"


Expand Down
0 tools/update_switcher.py → trx/tools/update_switcher.py
View file
Open in desktop
File renamed without changes.
Loading