Skip to content

Commit

Permalink
Add grouping for pkgdown reference page.
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Nov 18, 2024
1 parent c177880 commit 103f6b5
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,57 @@
url: https://r-pkg.thecoatlessprofessor.com/explorecourses/
template:
bootstrap: 5
bootswatch: cosmo
bslib:
primary: "#8C1515" # Stanford cardinal red
font-size-base: 0.95rem

navbar:
structure:
left: [intro, reference, news]
right: [search, github]
components:
reference:
text: API Reference
href: reference/index.html
github:
icon: fab fa-github
aria-label: GitHub logo
href: https://github.com/username/explorecourses

reference:
- title: Main Functions
desc: Core functions for fetching course data
contents:
- fetch_departments
- fetch_department_courses
- fetch_all_courses

- title: Cache Management
desc: Functions for managing the local cache
contents:
- starts_with("cache_")
- read_xml_cache
- clear_cache
- list_cache
- print.explorecourses_cache_list

- title: Internal Functions
desc: Internal helper functions and utilities
contents:
- starts_with("process_")
- starts_with("extract_")
- starts_with("make_")
- generate_academic_year
- validate_academic_year

home:
sidebar:
structure: [links, license, community, citation, authors, dev]

footer:
structure:
left: developed_by
right: built_with
components:
built_with: Built with {pkgdown}

0 comments on commit 103f6b5

Please sign in to comment.