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

Documentation #287

Open
cthoyt opened this issue Aug 4, 2022 · 1 comment
Open

Documentation #287

cthoyt opened this issue Aug 4, 2022 · 1 comment

Comments

@cthoyt
Copy link

cthoyt commented Aug 4, 2022

It doesn't appear this project has documentation (jupyter notebooks don't count :p). Would highly suggest using sphinx to auto-generate some

@LucaCappelletti94
Copy link
Collaborator

Hello, the documentation of embiggen, as it is a submodule of 🍇, is in 🍇. We are working to update the currently available documentation, which can be seen in the main package page.

We are lagging behind on that because we cannot use software like sphinx et similia, as the number of methods and classes we have in 🍇 is in the tens of thousands, leading to GBs of documentation (if left to sphinx).

We have now finished building a Rust and python parser to build a custom website which should easily be hostable on GitHub.

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

No branches or pull requests

2 participants