Skip to content

fix: read RAVEN's MATLAB functions from src/ #88

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
edkerk merged 1 commit into from
Oct 17, 2026
Merged

fix: read RAVEN's MATLAB functions from src/ #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 RAVEN
Open in desktop
Submodule RAVEN updated 623 files
3 changes: 3 additions & 0 deletions scripts/api_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
# can be pointed elsewhere -- e.g. at a working checkout of either toolbox --
# which is useful when a submodule cannot be moved to the tracked commit.
RAVEN = Path(os.environ.get("RAVEN_DOCS_RAVEN_SRC", ROOT / "RAVEN"))
# RAVEN keeps its MATLAB functions under src/; older checkouts have them at the root.
if (RAVEN / "src").is_dir():
RAVEN = RAVEN / "src"
PYPKG = Path(
os.environ.get(
"RAVEN_DOCS_PYTHON_SRC", ROOT / "raven-toolbox" / "src" / "raven_toolbox"
Expand Down
2 changes: 1 addition & 1 deletion scripts/gen_api_pages_sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ def collect_python_full() -> list[dict]:
# Page rendering #
# --------------------------------------------------------------------------- #
def render_matlab_page(title: str, folder: str, funcs: list[dict]) -> str:
out = [f"# {title}", "", f"MATLAB functions in `RAVEN/{folder}` of the RAVEN toolbox.", "",
out = [f"# {title}", "", f"MATLAB functions in `RAVEN/src/{folder}` of the RAVEN toolbox.", "",
"## Functions", "", "| Function | Summary |", "|---|---|"]
for f in funcs:
out.append(f"| [`{f['name']}`](#{slug(f['name'])}) | {cell(f['summary'])} |")
Expand Down