Skip to content
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.

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

Fix wording, example with two mapped dimensions does not support NN/HNSW #931

Merged
merged 2 commits into from
Sep 24, 2024

Conversation

jobergum
Copy link

I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.

@jobergum jobergum requested a review from thomasht86 September 23, 2024 08:59
@thomasht86
Copy link
Collaborator

I think that the cells in the notebooks will try to get executed during build on readthedocs if they are not executed at commit.
From https://nbsphinx.readthedocs.io/en/0.5.0/pre-executed.html:

Automatically executing notebooks during the Sphinx build process is an important feature of nbsphinx. However, there are a few use cases where pre-executing a notebook and storing the outputs might be preferable. Storing any output will, by default, stop nbsphinx from executing the notebook.

The readthedocs-environment (which is separate from the github runners) does not have access to secrets, so the unexecuted cell below:

from vespa.application import Vespa

app: Vespa = vespa_cloud.deploy()

will likely fail due to missing key. Found this out the hard way myself :D

As for the failed links, it looks like our reference docs were not built correctly on last run for some reason, https://pyvespa.readthedocs.io/en/latest/reference-api.html - I am investigating.

@thomasht86 thomasht86 merged commit 958eccf into master Sep 24, 2024
43 of 44 checks passed
@thomasht86 thomasht86 deleted the jobergum/fix-up-wording branch September 24, 2024 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants