Skip to content

Track current documentation in git #18

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 1 commit into from
Mar 28, 2022
Merged

Track current documentation in git #18

merged 1 commit into from
Mar 28, 2022

Conversation

dshemetov
Copy link
Contributor

Addresses #15. Might want to do a documentation pass before merging, but I'm unsure how to preview the docs from a PR. We need to set GH pages to host the docs, maybe?

@dshemetov dshemetov requested a review from brookslogan March 22, 2022 05:35
@brookslogan
Copy link
Contributor

Previewing docs can be done by

devtools::build_manual()

and looking at the pdf, or

devtools::install()
help(package="delphi.epidata") # for index of help topics --- this isn't supported when we are using devtools::load_all
[plus cleanup:]
remove.packages("delphi.epidata")
[restart R session]
devtools::load_all(export_all=FALSE) # for help on individual topics, we can use install or load_all
## browse through index)
help(delphi.epidata::covid_hosp_facility)
help(delphi.epidata::covid_hosp_facility_lookup)
[...]

Copy link
Contributor

@brookslogan brookslogan left a comment

Choose a reason for hiding this comment

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

Looks good to me. The documentation looks pretty bare-bones and might need a few corrections or completions, but I think it makes sense to go ahead and merge anyway.

For previewing documentation / documentation website easily within a PR, maybe we can check with covidcast developers who might already know how. (Also for how they publish the documentation website for main somewhere, if that's not already happening.) One way to preview the pdf manual would be to track the manual in the repo as well, but that's a bit inconvenient/forgetfullness-prone as devtools::document does not build the pdf manual by default and it takes a bit of time.

@krivard krivard merged commit 0e9c7c9 into dev Mar 28, 2022
@krivard krivard deleted the ds/track-documentation branch March 28, 2022 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants