Skip to content
Snippets Groups Projects
Commit 309c0a34 authored by Frederik Hennig's avatar Frederik Hennig
Browse files

add tips n tricks section to docs

parent 36c55793
No related merge requests found
......@@ -10,4 +10,5 @@ is required.
Generator scripts, which are Python scripts that, when executed, emit *pystencils*-generated code to a header/source
file pair with the same name as the script.
- [In-Depth: Building Source Files](building.md)
- [CLI and Build System Integration](cli_and_build_system.md)
\ No newline at end of file
- [CLI and Build System Integration](cli_and_build_system.md)
- [Tips And Tricks](tips_n_tricks.md): A collection of various tricks that might come in handy when working with *pystencils-sfg*.
\ No newline at end of file
## Make CLion treat generated files as project sources
When working on a CMake project in [CLion](https://www.jetbrains.com/clion/) that uses `pystencils-sfg`'s CMake
module for on-the-fly code generation, it is likely that CLion refuses to treat generated files as project sources.
Instead, the IDE will show the message:
> This file does not belong to any project target; code insight features might not work properly.
The reason behind this is that the generated files lie in the build directories.
To solve this, simply navigate to the CMake build directory in CLion's *Project* view,
right-click on the `sfg_sources` subfolder and select `Mark Directory as -> Project Sources and Headers`.
CLion should now treat all generated files in this directory as project source files.
......@@ -50,6 +50,7 @@ nav:
- 'Writing Generator Scripts': usage/generator_scripts.md
- 'In-Depth: Building Source Files': usage/building.md
- 'CLI and Build System Integration': usage/cli_and_build_system.md
- 'Tips and Tricks': usage/tips_n_tricks.md
- 'API Documentation':
- 'Overview': api/index.md
- 'Front End':
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment