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

📚 Quarto + Quaro Books for Documentation #43

Merged
merged 38 commits into from
Jan 6, 2025
Merged

Conversation

serkor1
Copy link
Owner

@serkor1 serkor1 commented Jan 6, 2025

📚 What?

This PR replaces {pkgdown} with Quarto books for package documentation. The documentation renders on changes to its yaml-file or modification of the /docs folder. It is still a work in progress, and needs some serious polishing when the package is ready for CRAN submission.

serkor1 added 30 commits January 5, 2025 10:51
* {pkgdown} are to be replaced with Quarto books.
Signed-off-by: Serkan Korkmaz <[email protected]>
Signed-off-by: Serkan Korkmaz <[email protected]>
Signed-off-by: Serkan Korkmaz <[email protected]>
Signed-off-by: Serkan Korkmaz <[email protected]>
* README is now .qmd, and the Makefile have been updated accordingly.
* The book is now pretty much in its template version.
Installing R step added.

Signed-off-by: Serkan Korkmaz <[email protected]>
Removed sudo from {devtools} libraries may have been installeld elsewhere.

Signed-off-by: Serkan Korkmaz <[email protected]>
Added secret github creds - everything should work now. Committed from my phone so there might be indentation errors. TODO: conditional rendering of docd
* Used proper syntax
If will only trigger if stuff has changed in the docs folder
* Latex is failing at the moment
* Used he built-in functionality instead
* It compiles locally; must be a dependency issue...
This run should be faster due to caching...
Signed-off-by: Serkan Korkmaz <[email protected]>
Signed-off-by: Serkan Korkmaz <[email protected]>
Signed-off-by: Serkan Korkmaz <[email protected]>
Signed-off-by: Serkan Korkmaz <[email protected]>
Signed-off-by: Serkan Korkmaz <[email protected]>
* It has been so much customized that I want to take ownership of it!
@serkor1 serkor1 merged commit 55e5e13 into development Jan 6, 2025
5 of 6 checks passed
@serkor1 serkor1 deleted the quarto-docs branch January 6, 2025 11:53
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.

1 participant