Skip to content

Generate doc pages for blueprint views#6121

Merged
jleibs merged 9 commits intomainfrom
jleibs/blueprint_doc_codegen
Apr 26, 2024
Merged

Generate doc pages for blueprint views#6121
jleibs merged 9 commits intomainfrom
jleibs/blueprint_doc_codegen

Conversation

@jleibs
Copy link
Copy Markdown
Contributor

@jleibs jleibs commented Apr 25, 2024 •
edited by github-actions bot
Loading

What

Add blueprint views to the python docs index.

Create a reference page for each view with documentation of its view properties and an example when provided.

Generating pages for all the blueprint archetypes and cross-linking still felt a bit overwhelming. Since these properties are almost always only used in the context of the view, I decided to inline instead.

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

To run all checks from main, comment on the PR with @rerun-bot full-check.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 25, 2024 •
edited
Loading

Deployed docs

Commit Link
ba23873 https://landing-gve1p5zfv-rerun.vercel.app/docs

@jleibs jleibs added 📖 documentation Improvements or additions to documentation 🟦 blueprint The data that defines our UI include in changelog labels Apr 25, 2024
@jleibs jleibs marked this pull request as ready for review April 25, 2024 20:16
@jleibs jleibs added the do-not-merge Do not merge this PR label Apr 25, 2024
@jleibs jleibs requested a review from jprochazk April 25, 2024 20:22
@jleibs
Copy link
Copy Markdown
Contributor Author

jleibs commented Apr 25, 2024

@jprochazk I could use a hand understanding why this broke the doc preview.

@jprochazk
Copy link
Copy Markdown
Member

jprochazk commented Apr 25, 2024

You didn't, it's broken on main. Trying to bisect

@jprochazk
Copy link
Copy Markdown
Member

jprochazk commented Apr 25, 2024

Broken since #5966 🤔

Wumpf
Wumpf approved these changes Apr 26, 2024
View reviewed changes
@Wumpf
Copy link
Copy Markdown
Member

Wumpf commented Apr 26, 2024

(tentative approval, we have to fix the preview)

@jprochazk
Copy link
Copy Markdown
Member

jprochazk commented Apr 26, 2024

Preview is fixed by rebasing

@Wumpf
Copy link
Copy Markdown
Member

Wumpf commented Apr 26, 2024

oops. how did that happen, just wanted to merge main. fixing.

@Wumpf Wumpf force-pushed the jleibs/blueprint_doc_codegen branch from 23b01df to 9957d7d Compare April 26, 2024 12:49
@Wumpf
Copy link
Copy Markdown
Member

Wumpf commented Apr 26, 2024

didn't notice that this pr is targeting another branch. that's why. undid my merge

Base automatically changed from jleibs/blueprint_snippets to main April 26, 2024 13:44
@jleibs jleibs removed the do-not-merge Do not merge this PR label Apr 26, 2024
@jleibs jleibs force-pushed the jleibs/blueprint_doc_codegen branch from 9957d7d to ba23873 Compare April 26, 2024 13:55
@jleibs jleibs merged commit 2ff6a44 into main Apr 26, 2024
@jleibs jleibs deleted the jleibs/blueprint_doc_codegen branch April 26, 2024 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Wumpf Wumpf Wumpf approved these changes

@jprochazk jprochazk Awaiting requested review from jprochazk

Assignees

No one assigned

Labels

🟦 blueprint The data that defines our UI 📖 documentation Improvements or additions to documentation include in changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jleibs @jprochazk @Wumpf