diff --git a/docs/usage/index.md b/docs/usage/index.md index d7069872af36ec99316d48ee031205fc6399a971..d4ceba027d6705188463f46a553698983ab04906 100644 --- a/docs/usage/index.md +++ b/docs/usage/index.md @@ -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 diff --git a/docs/usage/tips_n_tricks.md b/docs/usage/tips_n_tricks.md new file mode 100644 index 0000000000000000000000000000000000000000..06c74d6af6931a5d4773122a8dd06c7a2e8756cb --- /dev/null +++ b/docs/usage/tips_n_tricks.md @@ -0,0 +1,14 @@ + +## 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. diff --git a/mkdocs.yml b/mkdocs.yml index e0fb011b674af427d62255eb24c3229d1d82fe5c..86f75a5ba6a83cceb8f070c212c0f81565ecc308 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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':