You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<li>Update all dependencies: <code>poetry update</code></li>
228
228
</ul>
229
+
<p>If you are using VSCode or Cursor as your IDE, you will need to select the Poetry-managed Python version as your interpreter for the project. To find the location of the Poetry-managed Python interpreter, run <code>poetry env info</code> and look for the <code>Path</code> field. Then, in VSCode, go to <code>View > Command Palette</code>, search for <code>Python: Select Interpreter</code>, and either select Poetry’s Python version from the list (if it has been auto-detected) or “Enter interpreter path” manually.</p>
<spanid="cb1-9"><ahref="#cb1-9" aria-hidden="true" tabindex="-1"></a><spanclass="fu">}</span></span></code><buttontitle="Copy to Clipboard" class="code-copy-button"><iclass="bi"></i></button></pre></div>
229
-
<p>Simply create a <code>.devcontainer</code> folder in the root of the project and add a <code>devcontainer.json</code> file in the folder with the above content. VSCode may prompt you to install the Dev Container extension if you haven’t already, and/or to open the project in a container. If not, you can manually select “Dev Containers: Reopen in Container” from View > Command Palette.</p>
230
+
<p>Simply create a <code>.devcontainer</code> folder in the root of the project and add a <code>devcontainer.json</code> file in the folder with the above content. VSCode may prompt you to install the Dev Container extension if you haven’t already, and/or to open the project in a container. If not, you can manually select “Dev Containers: Reopen in Container” from <code>View > Command Palette</code>.</p>
230
231
<p><em>IMPORTANT: If using this dev container configuration, you will need to set the <code>DB_HOST</code> environment variable to “host.docker.internal” in the <code>.env</code> file.</em></p>
<p>(Note: You will need to activate the shell every time you open a new terminal session. Alternatively, you can use the <code>poetry run</code> prefix before other commands to run them without activating the shell.)</p>
<p>If you are using VSCode or Cursor as your IDE, you will need to select the Poetry-managed Python version as your interpreter for the project. To find the location of the Poetry-managed Python interpreter, run <code>poetry env info</code> and look for the <code>Path</code> field. Then, in VSCode, go to <code>View > Command Palette</code>, search for <code>Python: Select Interpreter</code>, and either select Poetry’s Python version from the list (if it has been auto-detected) or “Enter interpreter path” manually.</p>
272
+
<p>It is also recommended to install the <ahref="https://marketplace.visualstudio.com/items?itemName=ms-python.python">Python</a> and <ahref="https://marketplace.visualstudio.com/items?itemName=quarto.quarto">Quarto</a> IDE extensions.</p>
Copy file name to clipboardExpand all lines: docs/static/documentation.txt
+9-1Lines changed: 9 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -519,7 +519,7 @@ If you use VSCode with Docker to develop in a container, the following VSCode De
519
519
}
520
520
```
521
521
522
-
Simply create a `.devcontainer` folder in the root of the project and add a `devcontainer.json` file in the folder with the above content. VSCode may prompt you to install the Dev Container extension if you haven't already, and/or to open the project in a container. If not, you can manually select "Dev Containers: Reopen in Container" from View > Command Palette.
522
+
Simply create a `.devcontainer` folder in the root of the project and add a `devcontainer.json` file in the folder with the above content. VSCode may prompt you to install the Dev Container extension if you haven't already, and/or to open the project in a container. If not, you can manually select "Dev Containers: Reopen in Container" from `View > Command Palette`.
523
523
524
524
*IMPORTANT: If using this dev container configuration, you will need to set the `DB_HOST` environment variable to "host.docker.internal" in the `.env` file.*
525
525
@@ -570,6 +570,12 @@ poetry shell
570
570
571
571
(Note: You will need to activate the shell every time you open a new terminal session. Alternatively, you can use the `poetry run` prefix before other commands to run them without activating the shell.)
572
572
573
+
### Configure IDE
574
+
575
+
If you are using VSCode or Cursor as your IDE, you will need to select the Poetry-managed Python version as your interpreter for the project. To find the location of the Poetry-managed Python interpreter, run `poetry env info` and look for the `Path` field. Then, in VSCode, go to `View > Command Palette`, search for `Python: Select Interpreter`, and either select Poetry's Python version from the list (if it has been auto-detected) or "Enter interpreter path" manually.
576
+
577
+
It is also recommended to install the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Quarto](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) IDE extensions.
578
+
573
579
## Install documentation dependencies manually
574
580
575
581
### Quarto CLI
@@ -661,6 +667,8 @@ The project uses Poetry to manage dependencies:
661
667
- Install dependencies: `poetry install`
662
668
- Update all dependencies: `poetry update`
663
669
670
+
If you are using VSCode or Cursor as your IDE, you will need to select the Poetry-managed Python version as your interpreter for the project. To find the location of the Poetry-managed Python interpreter, run `poetry env info` and look for the `Path` field. Then, in VSCode, go to `View > Command Palette`, search for `Python: Select Interpreter`, and either select Poetry's Python version from the list (if it has been auto-detected) or "Enter interpreter path" manually.
671
+
664
672
### Testing
665
673
666
674
The project uses Pytest for unit testing. It's highly recommended to write and run tests before committing code to ensure nothing is broken!
0 commit comments