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 should be restructured #75

Open
vnmanoharan opened this issue Jun 22, 2019 · 0 comments
Open

Documentation should be restructured #75

vnmanoharan opened this issue Jun 22, 2019 · 0 comments

Comments

@vnmanoharan
Copy link
Contributor

Now that the number of features has expanded dramatically, we need a new way of organizing the documentation. Notebooks are good for demonstrating features, but they are not easily searchable. We should consider having a short tutorial notebook that demonstrates some (but not all) of the features, and moving the rest of the documentation to Sphinx. Sphinx also allows us to use doctests.

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

1 participant