Skip to content
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.

Sign up for GitHub

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

Jump to bottom

pkgdown documentation clean up #85

Merged
merged 11 commits into from
Jun 5, 2024
Merged

pkgdown documentation clean up #85

merged 11 commits into from
Jun 5, 2024

Conversation

andybeet
Copy link
Member

@andybeet andybeet commented Jun 3, 2024

pkgdown

  • Added missing functions and data sets to pgkdown yml
  • Edited rmds to conform to pkgdown standards and so site builds
  • Added viridis package to DESCRIPTION suggests. used in vignette
  • Edited format of Rpath_pkg.r file. New standards

R files

  • Edited plotting function rsim.plot to remove unintentional blank plot

Removed content

  • vignette html files (these are now gitignored). They are created on demand either locally or via github action

@andybeet
add Models section in pkgdown yml
655aeef
@andybeet
Merge branch 'master' of https://github.com/NOAA-EDAB/Rpath into dev
6087226
@andybeet
Update help files.
c3a1fa2 
- main package doc updated with new format
- other rd updates (order changed)
- intermediate vignette R files
@andybeet
reorganized .gitignore
39de1fe
@andybeet
added new rsim.sense functions to pkgdown
d18025a
@andybeet
edited rsim.plot to remove blank image that gets creaed
97b9ef5
@andybeet
added missing viridis package to DESCRIPTION
9711a5f
@andybeet
removed whitespace from names of rchunks in rmds
f026c7b 
- vignettes title = vignette entry name
@andybeet
ecosense rmd rework
236d660 
- changed output to match pkgdown format
- removed loading of objects already available by lazyload
- removed sourcing of functions available in package
- added rchunk names
@andybeet
removed html files
6933202 
- these are generated by pkgdown in workflow and locally. no longer needed to be tracked by git
@andybeet
dont flag warnings as errors in R CMD check
542b552
@andybeet andybeet requested a review from kaydin June 3, 2024 17:55
@andybeet
Copy link
Member Author

andybeet commented Jun 3, 2024

@kaydin This should be good to pull into the main branch. If you want to do some testing then switch to dev, pull, then run pkgdown::build_site(). This will create a local version of the site in your docs folder. You can then get a preview

@kaydin kaydin merged commit 477dc79 into master Jun 5, 2024
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kaydin kaydin Awaiting requested review from kaydin

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@andybeet @kaydin