Skip to content

Commit

Permalink
Squash merge of branch pkgdown-test
Browse files Browse the repository at this point in the history
commit 23ca8c8
commit 9f3af71
commit 09358f9
commit d694624
commit 25912bd
commit 12b6ac4
commit ff97fca
commit e66080b
commit b9264fd
commit 62eaa92
commit a228b44
commit 05eb36a
commit 32d4d91
commit b55ee90
commit 33f8754
  • Loading branch information
Martin Elff committed Dec 28, 2023
1 parent 8fd3f51 commit a845d77
Show file tree
Hide file tree
Showing 3 changed files with 178 additions and 2 deletions.
54 changes: 54 additions & 0 deletions .github/workflows/pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master,pkgdown-test]
pull_request:
branches: [main, master,pkgdown-test]
release:
types: [published]
workflow_dispatch:

name: pkgdown

jobs:
pkgdown:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, any::roxygen2, local::.
needs: website
working-directory: pkg

- name: Copy Readme
run: cp -a README.md pkg

- name: Run roxygen2
run: roxygen2::roxygenize(package.dir="pkg")
shell: Rscript {0}

- name: Build site
run: pkgdown::build_site_github_pages(pkg = "pkg", dest_dir = "../docs", new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/[email protected]
with:
clean: false
branch: gh-pages
folder: docs
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
This is a re-creation from scratch of an [*R*](http://www.r-project.org) kernel
for [*Jupyter*](http://juypter.org).

![A demonstration of interactive distribution plots](gifs/Interactive-distributions-demo.gif)

![A demonstration of interactive distribution plots](https://raw.githubusercontent.com/melff/RKernel/main/gifs/Display-demo.gif)

To install run the following lines in *R*:

Expand Down Expand Up @@ -54,7 +55,7 @@ This kernel differs from the already existing [*IRKernel*](http://irkernel.githu
- There is also a support for virtual table display (based on the ipywidget
infrastructure).

![A demonstration of some display facilities](gifs/Display-demo.gif)
![A demonstration of some display facilities](https://raw.githubusercontent.com/melff/RKernel/main/gifs/Display-demo.gif)


Some demonstration notebooks can be found [here](https://tmphub.elff.eu/user-redirect/).
Expand Down
121 changes: 121 additions & 0 deletions pkg/pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
url: https://melff.github.io/RKernel
template:
bootstrap: 5
bootswatch: sandstone
reference:
- title: "Display facilities"
contents:
- CSS
- IFrame
- Javascript
- View
- add_displayed_classes
- add_paged_classes
- alert
- display
- display_data
- envBrowser
- help.start
- ls_str
- raw_html
- remove_displayed_classes
- remove_paged_classes
- title: "Traitlets"
contents:
- Boolean
- Bytes
- DateClass
- DatetimeClass
- DatetimePicker
- Dict
- Fixed
- Float
- Integer
- List
- Page
- StrEnum
- StrEnumClass
- TimeClass
- Traitlets
- Unicode
- UnicodeClass
- Vector
- title: "Widgets"
contents:
- BoundedFloatRangeWidget
- BoundedFloatText
- BoundedFloatWidget
- BoundedIntText
- BoundedIntWidget
- BoundedLogFloatWidget
- Boxes
- Button
- Checkboxes
- ColorPicker
- ColorTrait
- CoreWidgetClass
- DOMWidgetClass
- DatePicker
- DescriptionStyle
- DescriptionWidget
- FileUpload
- FloatText
- FloatWidget
- IntText
- IntWidget
- LaTeXMath
- Layout
- LayoutTemplates
- MediaWidget
- OutputWidget
- Play
- PlotWidget
- Progress
- SelectionContainer
- SelectionWidget
- Sidecar
- Slider
- StringWidget
- TagsInput
- TimePicker
- Togglebuttons
- Valid
- ValueWidgetClass
- WidgetLink
- Widgets
- dataTable
- title: "Interactions"
contents:
- BreakPoint
- Trace
- interaction
- mkWidget
- title: "Utilities"
contents:
- cell.options
- dump.frames
- dictionary
- with.Context
- title: "Internal functions"
contents:
- CallbackDispatcher
- Comm
- CommManager
- Context
- Evaluator
- EventManager
- Graphics
- HasTraits
- Kernel
- R6Class_
- R6Instance
- R6TraitClass
- display_id
- install
- main
- register_magic_handler
- services
- sharedHelpServer
- to_json
- tracing_source
- virtable_widget

0 comments on commit a845d77

Please sign in to comment.