Skip to content

Update project_structure.mdx #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MobyNL merged 1 commit into from
Apr 4, 2025
Merged

Update project_structure.mdx #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions website/docs/examples/project_structure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Reusable keywords are stored in `.resource` files in the `resources` folder.
Also `Python` keywords in `.py` files can be stored there.

- `resources/` - Reusable keywords
- `common.robot` - General Keywords (e.g. Login/Logout, Navigation, ...) are stored here
- `search.robot` - Keywords for searching are stored here
- `common.resource` - General Keywords (e.g. Login/Logout, Navigation, ...) are stored here
- `search.resource` - Keywords for searching are stored here
- `utils.py` - Python helper keywords are stored here
- ...

Expand Down Expand Up @@ -237,18 +237,18 @@ You can also find the setting under `File > Preferences > Settings` by searching

:::tip

You can also add the `resources/` , `lib/` or `keyword/` folders to the `pythonPath` setting:
You can also add the `resources/` , `libraries/` or `keywords/` folders to the `pythonPath` setting:

```json
"robotcode.robot.pythonPath": [
"./",
"./lib",
"./libraries",
"./resources",
"./keywords",
],
```

That way, you can import libraries, resources and variables from the `resources/`, `lib/` and `keyword/` folders without the `resources/`, `lib/` or `keyword/` prefix.
That way, you can import libraries, resources and variables from the `resources/`, `libraries/` and `keywords/` folders without the `resources/`, `libraries/` or `keywords/` prefix.

```robotframework
*** Settings ***
Expand Down Expand Up @@ -420,13 +420,13 @@ Now the tests run successfully.

:::tip

You can also add the `resources/` , `lib/` or `keyword/` folders to the `--pythonpath` setting:
You can also add the `resources/` , `libraries/` or `keywords/` folders to the `--pythonpath` setting:

```shell
$ robot --pythonpath .:./lib:./resources:./keywords tests/suiteA.robot
$ robot --pythonpath .:./libraries:./resources:./keywords tests/suiteA.robot
```

That way, you can import libraries, resources and variables from the `resources/`, `lib/` and `keyword/` folders without the `resources/`, `lib/` or `keyword/` prefix.
That way, you can import libraries, resources and variables from the `resources/`, `libraries/` and `keywords/` folders without the `resources/`, `libraries/` or `keywords/` prefix.

```robotframework
*** Settings ***
Expand Down Expand Up @@ -454,4 +454,4 @@ PowerShell
```powershell
> $env:PYTHONPATH += ";."
> robot tests/suiteA.robot
```
```