You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,19 @@ A Python script to generate offline documentation for [vega-lite](https://github
6
6
7
7
- In-page table of contents for all pages, including images and examples for each Vega-Lite spec property.
8
8
- Mobile friendly layout (sidebars have been removed)
9
-
- 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.)
9
+
- 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.)
10
10
11
11
## Custom Usage
12
12
13
-
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).
13
+
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).
14
14
15
-
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).
15
+
1. Clone `vega-lite` as a sibling directory of this repository using changes from [this PR](https://github.com/vega/vega-lite/pull/7642).
16
16
2. In that directory, run `yarn install && yarn docset` to generate the site
17
-
a. You may need to install `rbenv` and `Jekyll` to build the documentation site.
17
+
- You may need to install `rbenv`, `Jekyll`, and a recent version of Ruby to build the documentation site.
18
18
3. In your python virtual environment, add python dependencies: `pip install -r requirements.txt`
19
-
a. Using Jupyter is optional, but recommended for ease of debugging the notebook output.
19
+
- Using Jupyter is optional, but recommended for ease of debugging notebook output.
20
20
4. Run `jupyter notebook`, and double-click `generate-vega-lite-docset.ipynb`. Run all cells.
21
-
5. Your generated docset will be in `vega-lite.docset`
21
+
5. Your generated docset will be this directory `vega-lite.docset` . Use "File > Open Local Docset" to test the file before submitting it.
22
22
23
23
See [notebook](./generate-vega-lite-docset.ipynb) for detailed instructions. The `DEBUG` flag can be toggled to adjust the amount of logging.
0 commit comments