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

docs: generate and host R documentation #875

Closed
lidavidm opened this issue Jul 6, 2023 · 3 comments · Fixed by #977
Closed

docs: generate and host R documentation #875

lidavidm opened this issue Jul 6, 2023 · 3 comments · Fixed by #977

Comments

@lidavidm
Copy link
Member

lidavidm commented Jul 6, 2023

No description provided.

@lidavidm lidavidm added this to the ADBC Libraries 0.6.0 milestone Jul 6, 2023
@paleolimbot
Copy link
Member

Is the stock pkgdown sites what you had in mind (sort of like what we do for Arrow)? Those are easy to generate but don't quite fit in with the theme. The output is pretty structured (basically latex)...it might be possible to convert to reST and use Sphinx.

@lidavidm
Copy link
Member Author

lidavidm commented Aug 7, 2023

Yeah. I don't think the theme is too big a deal; if anything, it'd be better to give R users something familiar.

@paleolimbot
Copy link
Member

Got it...the default theme is pretty good and is easy to rig up! I have a system for doing this in nanoarrow that should work here, too.

@paleolimbot paleolimbot mentioned this issue Aug 14, 2023
Merged
paleolimbot added a commit that referenced this issue Aug 15, 2023
@paleolimbot
docs: Generate and host R documentation (#977)
500cb6b 
This PR adds the standard-issue pkgdown site build to the documentation
(and fixes a few build errors that were identified as a result of
building in that environment). The Packaging / Documentation job
contains an artifact with the generated documentation and I've included
a few images below.

<img width="270" alt="Screenshot 2023-08-15 at 4 55 35 PM"
src="https://github.com/apache/arrow-adbc/assets/10995762/3841ee1b-e344-4683-ab9a-02c60be0f4ca">

<img width="604" alt="Screen Shot 2023-06-28 at 3 14 32 PM"
src="https://github.com/apache/arrow-adbc/assets/10995762/f6e27b08-f52c-4ece-aab8-b6afde1623df">

<img width="1110" alt="Screenshot 2023-08-15 at 4 56 06 PM"
src="https://github.com/apache/arrow-adbc/assets/10995762/8824e453-8c24-4867-91e8-5148ed3c7e50">

Closes #875.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Generate and host R documentation paleolimbot/arrow-adbc
2 participants
@lidavidm @paleolimbot