Skip to content

Commit

Permalink
Docs tests: remove leading slash (#7170)
Browse files Browse the repository at this point in the history 
* Docs tests: remove leading slash

* Fix slash handling in link-data.json for the C++ docs

* Fix trailing slash handling for link-data.json for the Rust API docs

---------

Co-authored-by: Simon Hausmann <simon.hausmann@slint.dev>
  • Loading branch information
@NigelBreslaw @tronical
NigelBreslaw and tronical authored Dec 19, 2024
1 parent 5128297 commit 3fae8b2
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 67 deletions.
2 changes: 1 addition & 1 deletion api/cpp/docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@

for key in links.keys():
href = links[key]["href"]
url = f"https://slint.dev/releases/{version}/docs/slint{href}"
url = f"https://slint.dev/releases/{version}/docs/slint/{href}"
myst_substitutions[f"slint_href_{key}"] = url
rst_epilog += f".. |{key}| replace:: :code:`{key}`\n"
rst_epilog += f".. _{key}: {url}\n"
Expand Down
2 changes: 1 addition & 1 deletion docs/astro/tests/link-test.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { linkMap } from "../src/utils/utils";

test("Test all links", async ({ page }) => {
for (const [key, value] of Object.entries(linkMap)) {
const href = value.href.replace(/^\//, "");
const href = value.href;

// Skip testing anchor links (internal page references)
if (href.includes("#")) {
Expand Down
128 changes: 64 additions & 64 deletions internal/core-macros/link-data.json
View file
Original file line number Diff line number Diff line change
@@ -1,195 +1,195 @@
{
"AnimationRef": {
"href": "/reference/primitive-types#animation"
"href": "reference/primitive-types#animation"
},
"AnimationTick": {
"href": "/reference/global-functions/builtinfunctions/#animation-tick---duration"
"href": "reference/global-functions/builtinfunctions/#animation-tick---duration"
},
"angle": {
"href": "/reference/primitive-types#angle"
"href": "reference/primitive-types#angle"
},
"bool": {
"href": "/reference/primitive-types#bool"
"href": "reference/primitive-types#bool"
},
"brush": {
"href": "/reference/primitive-types#brush"
"href": "reference/primitive-types#brush"
},
"BorderRadiusRectangle": {
"href": "/reference/elements/rectangle#border-radius-properties"
"href": "reference/elements/rectangle#border-radius-properties"
},
"cache-rendering-hint": {
"href": "/reference/common/#cache-rendering-hint"
"href": "reference/common/#cache-rendering-hint"
},
"ColorsRef": {
"href": "/reference/colors-and-brushes"
"href": "reference/colors-and-brushes"
},
"color": {
"href": "/reference/primitive-types#color"
"href": "reference/primitive-types#color"
},
"ComponentLibraries": {
"href": "/guide/language/coding/file/#component-libraries"
"href": "guide/language/coding/file/#component-libraries"
},
"CommonProperties": {
"href": "/reference/common"
"href": "reference/common"
},
"duration": {
"href": "/reference/primitive-types#duration"
"href": "reference/primitive-types#duration"
},
"DebugFn": {
"href": "/reference/global-functions/builtinfunctions#debug"
"href": "reference/global-functions/builtinfunctions#debug"
},
"easing": {
"href": "/reference/primitive-types#easing"
"href": "reference/primitive-types#easing"
},
"EnumType": {
"href": "/reference/global-structs-enums"
"href": "reference/global-structs-enums"
},
"Expressions": {
"href": "/guide/language/coding/expressions-and-statements/"
"href": "guide/language/coding/expressions-and-statements/"
},
"float": {
"href": "/reference/primitive-types#float"
"href": "reference/primitive-types#float"
},
"FocusHandling": {
"href": "/guide/development/focus"
"href": "guide/development/focus"
},
"FontHandling": {
"href": "/guide/development/fonts"
"href": "guide/development/fonts"
},
"GridLayout": {
"href": "/reference/layouts/gridlayout"
"href": "reference/layouts/gridlayout"
},
"Globals": {
"href": "/reference/global-structs-enums"
"href": "reference/global-structs-enums"
},
"HorizontalBox": {
"href": "/reference/std-widgets/layouts/horizontalbox"
"href": "reference/std-widgets/layouts/horizontalbox"
},
"HorizontalLayout": {
"href": "/reference/layouts/horizontallayout"
"href": "reference/layouts/horizontallayout"
},
"Image": {
"href": "/reference/elements/image"
"href": "reference/elements/image"
},
"ImageType": {
"href": "/reference/primitive-types#image"
"href": "reference/primitive-types#image"
},
"int": {
"href": "/reference/primitive-types#int"
"href": "reference/primitive-types#int"
},
"KeyEvent": {
"href": "/reference/keyboard-input/overview"
"href": "reference/keyboard-input/overview"
},
"length": {
"href": "/reference/primitive-types#length"
"href": "reference/primitive-types#length"
},
"ListView": {
"href": "/reference/std-widgets/views/listview"
"href": "reference/std-widgets/views/listview"
},
"LineEdit": {
"href": "/reference/std-widgets/views/lineedit"
"href": "reference/std-widgets/views/lineedit"
},
"LinuxkmsBackend": {
"href": "/guide/backends-and-renderers/backend_linuxkms"
"href": "guide/backends-and-renderers/backend_linuxkms"
},
"Modules": {
"href": "/guide/language/coding/file/#modules"
"href": "guide/language/coding/file/#modules"
},
"Models": {
"href": "/guide/language/coding/repetition-and-data-models#models"
"href": "guide/language/coding/repetition-and-data-models#models"
},
"NumericTypes": {
"href": "/reference/primitive-types#numeric-types"
"href": "reference/primitive-types#numeric-types"
},
"Path": {
"href": "/reference/elements/path"
"href": "reference/elements/path"
},
"percent": {
"href": "/reference/primitive-types#percent"
"href": "reference/primitive-types#percent"
},
"physicalLength": {
"href": "/reference/primitive-types#physical-length"
"href": "reference/primitive-types#physical-length"
},
"PopupWindow": {
"href": "/reference/window/popupwindow"
"href": "reference/window/popupwindow"
},
"ProgressIndicator": {
"href": "/reference/std-widgets/basic-widgets/progressindicator"
"href": "reference/std-widgets/basic-widgets/progressindicator"
},
"Purity": {
"href": "/guide/language/concepts/reactivity"
"href": "guide/language/concepts/reactivity"
},
"Rectangle": {
"href": "/reference/elements/rectangle"
"href": "reference/elements/rectangle"
},
"relativeFontSize": {
"href": "/reference/primitive-types#relative-font-size"
"href": "reference/primitive-types#relative-font-size"
},
"slintFile": {
"href": "/guide/language/coding/file"
"href": "guide/language/coding/file"
},
"ScrollView": {
"href": "/reference/std-widgets/views/scrollview"
"href": "reference/std-widgets/views/scrollview"
},
"StandardButton": {
"href": "/reference/std-widgets/basic-widgets/standardbutton"
"href": "reference/std-widgets/basic-widgets/standardbutton"
},
"StringType": {
"href": "/reference/primitive-types#string"
"href": "reference/primitive-types#string"
},
"StructType": {
"href": "/reference/global-structs-enums"
"href": "reference/global-structs-enums"
},
"StyleWidgets": {
"href": "/reference/std-widgets/style"
"href": "reference/std-widgets/style"
},
"Text": {
"href": "/reference/elements/text/"
"href": "reference/elements/text/"
},
"TextEdit": {
"href": "/reference/std-widgets/views/textedit"
"href": "reference/std-widgets/views/textedit"
},
"TextInput": {
"href": "/reference/keyboard-input/textinput/"
"href": "reference/keyboard-input/textinput/"
},
"Timer": {
"href": "/reference/timer/"
"href": "reference/timer/"
},
"Types": {
"href": "/reference/primitive-types"
"href": "reference/primitive-types"
},
"VerticalBox": {
"href": "/reference/std-widgets/layouts/verticalbox"
"href": "reference/std-widgets/layouts/verticalbox"
},
"VerticalLayout": {
"href": "/reference/layouts/verticallayout"
"href": "reference/layouts/verticallayout"
},
"QtBackend": {
"href": "/guide/backends-and-renderers/backend_qt"
"href": "guide/backends-and-renderers/backend_qt"
},
"Window": {
"href": "/reference/window/window"
"href": "reference/window/window"
},
"WinitBackend": {
"href": "/guide/backends-and-renderers/backend_winit/"
"href": "guide/backends-and-renderers/backend_winit/"
},
"translations": {
"href": "/guide/development/translations"
"href": "guide/development/translations"
},
"backends_and_renderers": {
"href": "/guide/backends-and-renderers/backends_and_renderers/"
"href": "guide/backends-and-renderers/backends_and_renderers/"
},
"globals": {
"href": "/guide/language/coding/globals/"
"href": "guide/language/coding/globals/"
},
"quickstart": {
"href": "/tutorial/quickstart/"
"href": "tutorial/quickstart/"
},
"modules": {
"href": "/guide/language/coding/file/#modules"
"href": "guide/language/coding/file/#modules"
},
"index": {
"href": "/"
"href": ""
}

}
2 changes: 1 addition & 1 deletion internal/core-macros/slint_doc.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ impl Visitor {
.expect("Missing href in link-data.json")
.as_str()
.expect("invalid string in link-data.json");
format!("https://releases.slint.dev/{}/docs/slint{dst}", env!("CARGO_PKG_VERSION"),)
format!("https://releases.slint.dev/{}/docs/slint/{dst}", env!("CARGO_PKG_VERSION"),)
} else {
panic!("Unknown link {}", link);
};
Expand Down

0 comments on commit 3fae8b2

Please sign in to comment.