Skip to content

fix API docs versions #685

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
bdice merged 1 commit into from
Sep 18, 2025
Merged

fix API docs versions #685

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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,12 @@ cp -avR "${BACKUP_DIR}/api" _site

In a browser, navigate to the URL shown in the `jekyll serve` output (probably something like `http://127.0.0.1:4000/`) to see the rendered docs.

If the hot reloading in `jekyll serve` again deletes all the files in `api/`, just copy them in again.

```shell
cp -avR "${BACKUP_DIR}/api" _site
```

## PR submissions

Once you have code changes, submit a PR to the docs site. Netlify will generate
Expand Down
2 changes: 1 addition & 1 deletion _includes/api-docs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#### DOCS {% for version_name in versions -%}
{%- if api.version-overrides -%}
**[{{ version_name }} ({{ api.version-overrides[version_name] }})](/api/{{ api.path }}/{{ version_name }})**
{%- elsif api.name | downcase contains "ucxx" -%}
{%- elsif api.name == "libucxx" or api.name == "UCXX" -%}
**[{{ version_name }} ({{ site.data.releases[version_name].ucxx_version }})](/api/{{ api.path }}/{{ version_name }})**
{%- else -%}
**[{{ version_name }} ({{ site.data.releases[version_name].version }})](/api/{{ api.path }}/{{ version_name }})**
Expand Down