From 3fbe83d7e31979c252201a3d259bf188ac051d85 Mon Sep 17 00:00:00 2001 From: Simon Hausmann Date: Fri, 25 Aug 2023 11:04:36 +0200 Subject: [PATCH] Add back-links to advanced topics for Rust and C++ The invalid anchor in the RST is a hack that's required in order to get relative links working with sphinx (see https://github.com/sphinx-doc/sphinx/issues/701#issuecomment-697116337 ) --- api/cpp/docs/index.rst | 9 +++++++++ api/rs/slint/lib.rs | 3 +++ docs/reference/src/advanced/backends.md | 2 +- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/api/cpp/docs/index.rst b/api/cpp/docs/index.rst index 9d63d03a2b5..b2cf6446e33 100644 --- a/api/cpp/docs/index.rst +++ b/api/cpp/docs/index.rst @@ -35,6 +35,15 @@ Slint C++ documentation genindex +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: Advanced Topics + + Debugging Techniques <../slint/src/advanced/debugging_techniques.html#http://> + Selecting a Widget Style <../slint/src/advanced/style.html#http://> + Platform Backends <../slint/src/advanced/backends.html#http://> + .. image:: https://github.com/slint-ui/slint/workflows/CI/badge.svg :target: https://github.com/slint-ui/slint/actions :alt: GitHub CI Build Status diff --git a/api/rs/slint/lib.rs b/api/rs/slint/lib.rs index 78c2bcdd017..b082de3e1ea 100644 --- a/api/rs/slint/lib.rs +++ b/api/rs/slint/lib.rs @@ -16,6 +16,9 @@ This crate is the main entry point for embedding user interfaces designed with */ #![doc = concat!("* [The Slint Language Documentation](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/slint)")] +#![doc = concat!("* [Debugging Techniques](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/slint/src/advanced/debugging_techniques.html)")] +#![doc = concat!("* [Selecting a Widget Style](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/slint/src/advanced/style.html)")] +#![doc = concat!("* [Platform Backends](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/slint/src/advanced/backends.html)")] /*! * [Slint on Microcontrollers](docs::mcu) ## How to use this crate: diff --git a/docs/reference/src/advanced/backends.md b/docs/reference/src/advanced/backends.md index 1fc2f4a6e0e..89aac9cc6b3 100644 --- a/docs/reference/src/advanced/backends.md +++ b/docs/reference/src/advanced/backends.md @@ -1,6 +1,6 @@ -# Backends +# Platform Backends In Slint, a backend is the module that encapsulates the interaction with the operating system, in particular the windowing sub-system. Multiple backends can be compiled into Slint and one