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.

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

[REFACTOR] Evaluate if we can remove the man folder from the repository #30

Open
tbouffard opened this issue Aug 27, 2021 · 0 comments
Open
Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)

Comments

@tbouffard
Copy link
Member

tbouffard commented Aug 27, 2021

See #26 (comment)

The man folder contains only generated files except bpmnVisualization-package.Rd
This file could be generated as done in https://github.com/bergant/bpmn/blob/9768cccc551831846a6d404271e330d710c8ef3b/R/bpmn.R#L1 (add roxygen comments on a NULL statement)

We will probably use Roxygen2 that generates the Rmd files from documentation as R comments located in the source code (see https://kbroman.org/pkg_primer/pages/docs.html and https://r-pkgs.org/man.html)
Once roxygen2 is installed, documentation can be generated by calling devtools::document()
See also https://github.com/r-lib/roxygen2

The NAMESPACE file is also generated

To avoid roxygen2 warning roxygen2 requires Encoding: UTF-8
Add Encoding: UTF-8 to the DESCRIPTION file --> done in #49

For contributors, document RStudio configuration to be setup to avoid running doc generation when changing the code
The following in the default configuration. Some files aren't generated if the config is left unchanged.
image

@tbouffard tbouffard added this to the MVP milestone Aug 27, 2021
@tbouffard tbouffard changed the title [REFACTOR] Evaluate if we can remove the man folder from the repository [REFACTOR] Evaluate if we can remove the man folder from the repository Aug 30, 2021
@tbouffard tbouffard removed this from the MVP milestone Aug 31, 2021
@tbouffard tbouffard added chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) and removed infra:repo labels Aug 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)
Projects
None yet
Development

No branches or pull requests

1 participant