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

Add structure for mkdocs instead of Sphinx #225

Merged
merged 15 commits into from
Oct 28, 2022
Merged

Add structure for mkdocs instead of Sphinx #225

merged 15 commits into from
Oct 28, 2022

Conversation

Dref360
Copy link
Member

@Dref360 Dref360 commented Jul 1, 2022

Summary:

Makes the documentation pretty!
This is WIP as I would like for everyone to have a good look before merging.

This will break our website for a bit once it is merged.

Fixes #216

Features:

  • Use mkdocs-material for look
  • mkdocs-jupyter for jupyter notebook

no more rst, so it is easier to work on.

Checklist:

  • Your code is documented (To validate this, add your module to tests/documentation_test.py).
  • Your code is tested with unit tests.
  • You moved your Issue to the PR state.

@Dref360 Dref360 requested a review from parmidaatg July 1, 2022 21:33
@Dref360
Copy link
Member Author

Dref360 commented Aug 20, 2022

I found an issue where active_learning_process.ipynb generates a search map of 32Mb which kills the search bar. Investigating how to reduce the final animation size.

@Dref360 Dref360 marked this pull request as ready for review August 21, 2022 16:58
Copy link
Collaborator

@parmidaatg parmidaatg left a comment

Choose a reason for hiding this comment

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

I Love THIS. It is a more compact and easier to use tool.
Thanks for this.

@Dref360 Dref360 requested a review from parmidaatg October 15, 2022 22:39
@Dref360
Copy link
Member Author

Dref360 commented Oct 15, 2022

Everything is setup! Could @GeorgePearse and @parmidaatg re-review and then we deploy?

@Dref360 Dref360 merged commit 1fb6425 into master Oct 28, 2022
@Dref360 Dref360 deleted the docs/mkdocs branch October 28, 2022 21:46
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.

Improve look of documentation website
2 participants