Skip to content

Commit 8963d77

Browse files
Built site for gh-pages
1 parent f534f12 commit 8963d77

File tree

6 files changed

+23
-8
lines changed

6 files changed

+23
-8
lines changed

.nojekyll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
ee3921f1
1+
2e246554

docs/customization.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,7 @@ <h3 class="anchored" data-anchor-id="dependency-management-with-poetry">Dependen
226226
<li>Install dependencies: <code>poetry install</code></li>
227227
<li>Update all dependencies: <code>poetry update</code></li>
228228
</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 &gt; 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>
229230
</section>
230231
<section id="testing" class="level3">
231232
<h3 class="anchored" data-anchor-id="testing">Testing</h3>

docs/installation.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ <h2 id="toc-title">On this page</h2>
179179
<li><a href="#python-and-docker" id="toc-python-and-docker" class="nav-link" data-scroll-target="#python-and-docker">Python and Docker</a></li>
180180
<li><a href="#postgresql-headers" id="toc-postgresql-headers" class="nav-link" data-scroll-target="#postgresql-headers">PostgreSQL headers</a></li>
181181
<li><a href="#python-dependencies" id="toc-python-dependencies" class="nav-link" data-scroll-target="#python-dependencies">Python dependencies</a></li>
182+
<li><a href="#configure-ide" id="toc-configure-ide" class="nav-link" data-scroll-target="#configure-ide">Configure IDE</a></li>
182183
</ul></li>
183184
<li><a href="#install-documentation-dependencies-manually" id="toc-install-documentation-dependencies-manually" class="nav-link" data-scroll-target="#install-documentation-dependencies-manually">Install documentation dependencies manually</a>
184185
<ul class="collapse">
@@ -226,7 +227,7 @@ <h2 class="anchored" data-anchor-id="install-all-dependencies-in-a-vscode-dev-co
226227
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">"ghcr.io/rocker-org/devcontainer-features/quarto-cli:1"</span><span class="fu">:</span> <span class="fu">{}</span></span>
227228
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
228229
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="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 &gt; 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 &gt; Command Palette</code>.</p>
230231
<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>
231232
</section>
232233
<section id="install-development-dependencies-manually" class="level2">
@@ -265,6 +266,11 @@ <h3 class="anchored" data-anchor-id="python-dependencies">Python dependencies</h
265266
<div class="sourceCode" id="cb6"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">poetry</span> shell</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
266267
<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>
267268
</section>
269+
<section id="configure-ide" class="level3">
270+
<h3 class="anchored" data-anchor-id="configure-ide">Configure IDE</h3>
271+
<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 &gt; 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 <a href="https://marketplace.visualstudio.com/items?itemName=ms-python.python">Python</a> and <a href="https://marketplace.visualstudio.com/items?itemName=quarto.quarto">Quarto</a> IDE extensions.</p>
273+
</section>
268274
</section>
269275
<section id="install-documentation-dependencies-manually" class="level2">
270276
<h2 class="anchored" data-anchor-id="install-documentation-dependencies-manually">Install documentation dependencies manually</h2>

docs/static/documentation.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ If you use VSCode with Docker to develop in a container, the following VSCode De
519519
}
520520
```
521521

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`.
523523

524524
*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.*
525525

@@ -570,6 +570,12 @@ poetry shell
570570

571571
(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.)
572572

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+
573579
## Install documentation dependencies manually
574580

575581
### Quarto CLI
@@ -661,6 +667,8 @@ The project uses Poetry to manage dependencies:
661667
- Install dependencies: `poetry install`
662668
- Update all dependencies: `poetry update`
663669

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+
664672
### Testing
665673

666674
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

Comments
 (0)