Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
pystencils-sfg
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
pycodegen
pystencils-sfg
Commits
309c0a34
Commit
309c0a34
authored
1 year ago
by
Frederik Hennig
Browse files
Options
Downloads
Patches
Plain Diff
add tips n tricks section to docs
parent
36c55793
No related branches found
No related tags found
No related merge requests found
Pipeline
#58820
passed
1 year ago
Stage: pretest
Stage: test
Stage: deploy
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/usage/index.md
+2
-1
2 additions, 1 deletion
docs/usage/index.md
docs/usage/tips_n_tricks.md
+14
-0
14 additions, 0 deletions
docs/usage/tips_n_tricks.md
mkdocs.yml
+1
-0
1 addition, 0 deletions
mkdocs.yml
with
17 additions
and
1 deletion
docs/usage/index.md
+
2
−
1
View file @
309c0a34
...
...
@@ -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
This diff is collapsed.
Click to expand it.
docs/usage/tips_n_tricks.md
0 → 100644
+
14
−
0
View file @
309c0a34
## 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.
This diff is collapsed.
Click to expand it.
mkdocs.yml
+
1
−
0
View file @
309c0a34
...
...
@@ -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'
:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment