language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-10-17 22:08:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Move debugging techniques under advanced topics in the Slint reference

Browse source
This commit is contained in:
Simon Hausmann 2023-08-14 14:37:35 +02:00 • committed by Simon Hausmann
parent 870e0e541d
commit bf7e7e7323
6 changed files with 7 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api/cpp/docs/index.rst
View file

@ -35,8 +35,6 @@ Slint C++ documentation
genindex genindex
debugging_techniques.md
.. image:: https://github.com/slint-ui/slint/workflows/CI/badge.svg .. image:: https://github.com/slint-ui/slint/workflows/CI/badge.svg
:target: https://github.com/slint-ui/slint/actions :target: https://github.com/slint-ui/slint/actions
:alt: GitHub CI Build Status :alt: GitHub CI Build Status

5
api/rs/slint/docs.rs
View file

@ -134,11 +134,6 @@ pub mod generated_code {
} }
} }
pub mod debugging_techniques {
#![doc = include_str!("docs/debugging_techniques.md")]
#![doc = ""]
}
pub mod mcu { pub mod mcu {
#![doc = include_str!("mcu.md")] #![doc = include_str!("mcu.md")]
use crate::platform::software_renderer::*; use crate::platform::software_renderer::*;

1
api/rs/slint/lib.rs
View file

@ -17,7 +17,6 @@ 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!("* [The Slint Language Documentation](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/slint)")]
/*! * [Slint on Microcontrollers](docs::mcu) /*! * [Slint on Microcontrollers](docs::mcu)
* [Debugging Techniques](docs::debugging_techniques)
## How to use this crate: ## How to use this crate:

7
docs/reference/index.rst
View file

@ -40,3 +40,10 @@ There are three different pathways to get started with Slint:
:caption: Recipes & Examples :caption: Recipes & Examples
src/recipes/recipes.md src/recipes/recipes.md
.. toctree::
:hidden:
:maxdepth: 2
:caption: Advanced Topics
src/advanced/debugging_techniques.md

0
docs/debugging_techniques.md → docs/reference/src/advanced/debugging_techniques.md
View file

5
xtask/src/cppdocs.rs
View file

@ -76,11 +76,6 @@ pub fn generate(show_warnings: bool) -> Result<(), Box<dyn std::error::Error>> {
) )
.context("Error creating symlinks from docs source to docs build dir")?; .context("Error creating symlinks from docs source to docs build dir")?;
symlink_file(
["..", "..", "docs", "debugging_techniques.md"].iter().collect::<PathBuf>(),
docs_build_dir.join("debugging_techniques.md"),
)?;
symlink_file( symlink_file(
["..", "..", "api", "cpp", "README.md"].iter().collect::<PathBuf>(), ["..", "..", "api", "cpp", "README.md"].iter().collect::<PathBuf>(),
docs_build_dir.join("README.md"), docs_build_dir.join("README.md"),