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.

Sign up for GitHub

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

feat: update instructions and dependencies for Feb 2024 Release #5

Merged
merged 1 commit into from
Feb 11, 2024
Merged

feat: update instructions and dependencies for Feb 2024 Release #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ A Python script to generate offline documentation for [vega-lite](https://github

- In-page table of contents for all pages, including images and examples for each Vega-Lite spec property.
- Mobile friendly layout (sidebars have been removed)
- Quick search of all pages on the public docs page, including examples. (Note that examples that load remote data require an internet connection to load normally.)
- Quick search of all pages on the public docs page, including examples. (Note examples that load remote data require an internet connection to load normally.)

## Custom Usage

This step is only necessary if you intend to hack on the published docset locally. Otherwise, it can be installed from the Dash app or the [Dash contributions repository](https://github.com/Kapeli/Dash-User-Contributions).
This step is only necessary if you intend to modify the published docset locally. Otherwise, it can be installed from the Dash app or the [Dash contributions repository](https://github.com/Kapeli/Dash-User-Contributions).

1. Clone `vega-lite` as a sibling folder of this repository using the changes from [this PR](https://github.com/vega/vega-lite/pull/7642).
1. Clone `vega-lite` as a sibling directory of this repository using changes from [this PR](https://github.com/vega/vega-lite/pull/7642).
2. In that directory, run `yarn install && yarn docset` to generate the site
a. You may need to install `rbenv` and `Jekyll` to build the documentation site.
- You may need to install `rbenv`, `Jekyll`, and a recent version of Ruby to build the documentation site.
3. In your python virtual environment, add python dependencies: `pip install -r requirements.txt`
a. Using Jupyter is optional, but recommended for ease of debugging the notebook output.
- Using Jupyter is optional, but recommended for ease of debugging notebook output.
4. Run `jupyter notebook`, and double-click `generate-vega-lite-docset.ipynb`. Run all cells.
5. Your generated docset will be in `vega-lite.docset`
5. Your generated docset will be this directory `vega-lite.docset` . Use "File > Open Local Docset" to test the file before submitting it.

See [notebook](./generate-vega-lite-docset.ipynb) for detailed instructions. The `DEBUG` flag can be toggled to adjust the amount of logging.

Expand Down
Loading