Skip to content

Run configs #1236

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
merged 6 commits into from
Jun 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Default ignored files
.idea
!.idea/runConfigurations
!.idea/runConfigurations/*.xml
!.idea/externalDependencies.xml
!.idea/vcs.xml
.gradle
Expand Down
9 changes: 9 additions & 0 deletions .idea/runConfigurations/Build_Docs_Website.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions .idea/runConfigurations/Run_Docs_Website_Locally.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,32 @@ and included in the [StardustDocs/d.tree](./StardustDocs/d.tree) file.

Images all README files can be stored in [docs/imgs](./imgs).

## Running the Documentation Website Locally

⚠️ IFrames are not displayed when using the Writerside plugin preview. To view them correctly, you need to run the website locally.

### Option 1: Using IntelliJ IDEA Configurations

> Requires: `unzip` utility and **Python 3** installed in the environment. May not work properly on Windows.

1. Run the `Build Docs Website` configuration.
2. Run the `Run Docs Website Locally` configuration.
3. Open [http://localhost:8000/home.html](http://localhost:8000/home.html) in your browser.
4. Shut down the server with Ctrl+C or close the terminal window.

Copy link
Collaborator

Choose a reason for hiding this comment

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

step 4: ctrl+c to stop it? otherwise you might run into port-in-use issues

### Option 2: Manual Steps

1. Go to `Writerside > DataFrame(d) > Export To > Build Docs Website` or find Writerside web archive build in IDEA configuration.
2. Unzip the archive located at: `./build/ws/webHelpD2-all.zip`
3. Start a local web server in the extracted folder (e.g., using Python or `http-server` utility):
```bash
python3 -m http.server
# or
http-server
```
4. Open [http://localhost:8000/home.html](http://localhost:8000/home.html) in your browser.
5. Shut down the server with Ctrl+C or close the terminal window.

### Explainer dataframes
`@TransformDataFrameExpressions` annotated test functions generate sample
dataframe HTML files that can be used as iFrames on the documentation website.
Expand Down
6 changes: 3 additions & 3 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs
by [Korro](https://github.com/devcrocod/korro).

This module might be merged with [:core](../core): [Issue #898](https://github.com/Kotlin/dataframe/issues/898).

See https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md for details of
the Writerside docs generation.
Uses Kandy samples util.
See https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md for more details.