Skip to content

Commit

Permalink
pkgdown update
Browse files Browse the repository at this point in the history
  • Loading branch information
JestonBlu committed Jul 31, 2023
1 parent aa51ddb commit 6b60224
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 102 deletions.
35 changes: 11 additions & 24 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
release:
types: [published]
workflow_dispatch:
Expand All @@ -14,35 +12,24 @@ 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 }}
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v2

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

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

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

- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4.4.1
with:
clean: false
branch: gh-pages
folder: docs
- name: Deploy package
run: |
git config --local user.name "$GITHUB_ACTOR"
git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com"
Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
72 changes: 5 additions & 67 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
url: https://jestonblu.github.io/RobinHood/
template:
bootstrap: 5

# Nav bar customization
navbar:
structure:
Expand All @@ -18,81 +17,20 @@ navbar:
href: articles/passwords.html
- text: Function Relationship Plots
href: articles/network_graph.html

reference:
- title: "Core Functions"
desc: >
Core functions
desc: "Core functions"
- contents:
- RobinHood
- cancel_ach_transfer
- cancel_order
- cancel_order_crypto
- cancel_order_options
- get_accounts
- get_ach
- get_contracts
- get_fundamentals
- get_historicals
- get_historicals_crypto
- get_historicals_options
- get_market_hours
- get_order_history
- get_order_history_crypto
- get_order_history_options
- get_order_status
- get_order_status_crypto
- get_order_status_options
- get_portfolios
- get_positions
- get_positions_crypto
- get_positions_options
- get_quote
- get_quote_crypto
- get_ratings
- get_tag
- get_tickers
- get_user
- logout
- place_ach_transfer
- place_order
- place_order_crypto
- place_order_options
- watchlist
- starts_with("cancel")
- starts_with("get")
- starts_with("place")
- title: "Backend API Functions"
desc: "Backend API functions"
- contents:
- api_accounts
- api_accounts_crypto
- api_ach
- api_contracts
- api_currency_pairs
- api_endpoints
- api_fundamentals
- api_historicals
- api_historicals_crypto
- api_historicals_options
- api_instruments
- api_instruments_options
- api_login
- api_logout
- api_marketdata
- api_markets
- api_orders
- api_orders_crypto
- api_orders_options
- api_portfolios
- api_portfolios_crypto
- api_positions
- api_positions_crypto
- api_positions_options
- api_quote
- api_quote_crypto
- api_ratings
- api_tag
- api_tickers
- api_user
- api_watchlist
- starts_with("api")
- title: "Backend Utility Functions"
desc: "Backend utility functions"
- contents:
Expand Down
2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ articles:
getting_started: getting_started.html
network_graph: network_graph.html
passwords: passwords.html
last_built: 2023-07-31T02:00Z
last_built: 2023-07-31T16:30Z
urls:
reference: https://jestonblu.github.io/RobinHood/reference
article: https://jestonblu.github.io/RobinHood/articles
Expand Down
20 changes: 10 additions & 10 deletions docs/reference/index.html

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

0 comments on commit 6b60224

Please sign in to comment.