Skip to content

docs: avoid needing to render API docs for any preview/render invocation #10106

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

Merged

Conversation

cpcloud
Copy link
Member

@cpcloud cpcloud commented Sep 12, 2024

Because we include a generated file, this forces developers to render API docs, or delete the file that references the generated file. This PR fixes that by deleting the file using the include, and referencing the included file directly in _quarto.yml

@cpcloud cpcloud added the docs Documentation related issues or PRs label Sep 12, 2024
@cpcloud cpcloud requested a review from gforsyth September 12, 2024 16:48
@cpcloud cpcloud force-pushed the avoid-needing-to-render-api-docs branch from ecd4600 to 2dc37ba Compare September 12, 2024 16:49
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Sep 12, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Sep 12, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Sep 12, 2024

@cpcloud
Copy link
Member Author

cpcloud commented Sep 12, 2024

Pages and dropdown check out:

image
image

Copy link
Member

@gforsyth gforsyth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SHIP IT (and thank you for figuring this out)

@gforsyth gforsyth merged commit 34c465c into ibis-project:main Sep 12, 2024
21 checks passed
@cpcloud cpcloud deleted the avoid-needing-to-render-api-docs branch September 13, 2024 13:27
@cpcloud cpcloud added this to the 10.0 milestone Sep 13, 2024
ncclementi pushed a commit to ncclementi/ibis that referenced this pull request Sep 24, 2024
…ion (ibis-project#10106)

Because we include a generated file, this forces developers to render
API docs, or delete the file that references the generated file. This PR
fixes that by deleting the file using the include, and referencing the
included file directly in `_quarto.yml`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants