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

Webdocs experiment #136

Merged
merged 1 commit into from
May 31, 2022
Merged

Webdocs experiment #136

merged 1 commit into from
May 31, 2022

Conversation

johnkerl
Copy link
Member

@johnkerl johnkerl commented May 31, 2022

Please view this solely as a conversation-starter.

@johnkerl johnkerl force-pushed the kerl/web-docs-experiment branch 2 times, most recently from 953aa03 to 27856e1 Compare May 31, 2022 13:03
Copy link
Member

@aaronwolen aaronwolen left a comment

Choose a reason for hiding this comment

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

These look great! I can't speak to how/whether we can use this approach for the R docs but that's something we can discuss later. For now it's great to have a hosted website w/ docs for the python API.

@johnkerl
Copy link
Member Author

@aaronwolen thanks! Here's the deal about R docs:

  • For now of course they're in the separate repo https://github.com/TileDB-Inc/tiledbsc and well-hosted at https://tiledb-inc.github.io/tiledbsc/
  • R docs already do API+vignette marvelously
  • GitHub Pages is fine with single-language stuff (R or Python) but I haven't yet found a way to get GitHub Pages to handle multi-language content within a single repo -- which is why I went around that for this PR and chose S3 static hosting for the moment
  • We of course (independent of R/Python) need to set up CI, and also decide if we want S3 static hosting or something else
  • But to your question about R docs: I think we'll be best-served if we have CI render the R docs as now, and have this doctree point to that (and vice versa)

Basically letting the R-document framework do what it already does well right out of the box, and trying to get an almost-as-good setup for Python as well here, & having them each point to the other.

@johnkerl johnkerl merged commit a367a8c into main May 31, 2022
@johnkerl johnkerl deleted the kerl/web-docs-experiment branch June 1, 2022 13:25
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.

2 participants