Skip to content

Commit

Permalink
Add back-links to advanced topics for Rust and C++
Browse files Browse the repository at this point in the history
The invalid anchor in the RST is a hack that's required in order to get relative links
working with sphinx (see sphinx-doc/sphinx#701 (comment) )
  • Loading branch information
tronical committed Aug 25, 2023
1 parent 5182660 commit 3fbe83d
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
9 changes: 9 additions & 0 deletions api/cpp/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions api/rs/slint/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/src/advanced/backends.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- Copyright © SixtyFPS GmbH <info@slint.dev> ; SPDX-License-Identifier: MIT -->

# 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
Expand Down

0 comments on commit 3fbe83d

Please sign in to comment.