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

build: add build script for generating offline docsets #7642

Closed
wants to merge 5 commits into from

Conversation

hydrosquall
Copy link
Member

@hydrosquall hydrosquall commented Aug 9, 2021

Motivation

Changes

  • Use paths to html files in the menu bar consistently
  • Disable site features (SEO tags, statically serving data files) that aren't used by Docset in an alternate version of the docset build script

Testing

@hydrosquall hydrosquall self-assigned this Aug 9, 2021
@@ -53,6 +54,7 @@
"schema": "mkdir -p build && ts-json-schema-generator -f tsconfig.json -p src/index.ts -t TopLevelSpec --no-type-check --no-ref-encode > build/vega-lite-schema.json && yarn renameschema && cp build/vega-lite-schema.json site/_data/",
"renameschema": "scripts/rename-schema.sh",
"presite": "yarn data && yarn schema && yarn build:site && yarn build:versions && scripts/create-example-pages.sh",
"docset": "yarn schema && yarn build:site && yarn build:docset && yarn build:versions && scripts/create-example-pages.sh",
Copy link
Member Author

Choose a reason for hiding this comment

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

I skip the yarn data portion, since the docs can't read the served arrow/csv/json files via XMLHTTPRequest over the file system (which is how Dash serves them).

@hydrosquall hydrosquall force-pushed the cameron.yick/experiment-doc-generation branch from 1b0421e to 7cd4a30 Compare August 9, 2021 02:43
@hydrosquall hydrosquall changed the title build: Add documentation build script for docset offline doc browsing build: add build script for generating offline docsets Aug 9, 2021
@hydrosquall
Copy link
Member Author

Replaced by #9254

@hydrosquall hydrosquall closed this Feb 5, 2024
@hydrosquall hydrosquall deleted the cameron.yick/experiment-doc-generation branch February 5, 2024 00:11
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.

1 participant