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

Switch references to Quarto website? #1169

Open
eitsupi opened this issue Jul 18, 2024 · 3 comments
Open

Switch references to Quarto website? #1169

eitsupi opened this issue Jul 18, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@eitsupi
Copy link
Collaborator

eitsupi commented Jul 18, 2024

After switching to savvy (#1152), I found that wasm builds are possible (for now, see https://eitsupi.r-universe.dev/neopolars)
At the moment it seems that the code for the wasm target is not being used properly (rayon, thread pool), causing panic, but if the problem is resolved upstream, the polars package may work on webR.
In that case, switching to Quarto Website could make webR integration easier to use (etiennebacher/altdoc#253).

When this repository first switched from pkgdown to altdoc, the choice of mkdocs was reasonable because altdoc did not support Quarto, but today there is less reason to choose mkdocs than there was then.

@etiennebacher Thoughts?

@eitsupi eitsupi added the documentation Improvements or additions to documentation label Jul 18, 2024
@eitsupi eitsupi added this to the Rewrite milestone Jul 18, 2024
@etiennebacher
Copy link
Collaborator

We can keep track of this but I would say it's low-priority and doesn't need to be on the Rewrite milestone as it is a different objective. I'd say let's get back to this once the rewrite is done and stable.


Also, sorry for the lack of activity here in the recent weeks, I have some issues with my setup that make it complicated to compile polars for now (basically I can just compile it on a machine with 8GB of RAM and it freezes quite often, I hope to get it resolved soon).

@eitsupi
Copy link
Collaborator Author

eitsupi commented Jul 20, 2024

Sorry for the lack of explanation. I am planning to set up altdoc in the next branch, and while I am at it, I am going to make some changes from the existing scripts.

  • Replace usage section in Rd files instead of HTML files (build: add functions to update usage sections in Rd files #701)
  • Manually generate indexes instead of automatically generating them (same as py-polars, although the current automatic generation is great, it cannot handle detail exceptions, so I think it is ultimately easier to aim for the same state as py-polars by manual generation)

When changing the indexing system, I think it would be better to adopt Quarto from the beginning because the configuration files are different between mkdocs and Quarto.

Also, sorry for the lack of activity here in the recent weeks, I have some issues with my setup that make it complicated to compile polars for now (basically I can just compile it on a machine with 8GB of RAM and it freezes quite often, I hope to get it resolved soon).

Do not mind. But if you can use GitHub Codespaces, it might be an alternative.

@etiennebacher
Copy link
Collaborator

etiennebacher commented Jul 20, 2024

I am planning to set up altdoc in the next branch, and while I am at it, I am going to make some changes from the existing scripts.

Thank you for the explanation, but does this have to happen in the next branch? Why can't this be done after the rewrite?

When we merge next into main, it's gonna be a massive PR, I don't think it's a good idea to add even more stuff there that isn't essential for the rewrite (I assume that the current docs workflow works fine on the next branch, which I actually don't know. Maybe it is needed to update the docs workflow, but I didn't understand that from your previous post).

I would be more comfortable in making sure the rewrite is good first, and then adapt the docs to use Quarto instead of Mkdocs. It will also be easier for me to review and contribute to this documentation switch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants