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.

Sign up for GitHub

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

Jump to bottom

Modernize documentation build and feel #69

Merged
merged 5 commits into from
Apr 25, 2024
Merged

Modernize documentation build and feel #69

merged 5 commits into from
Apr 25, 2024

Conversation

michaelosthege
Copy link
Member

@michaelosthege michaelosthege commented Apr 23, 2024 •
edited
Loading

  • ✨ Switching to the Sphinx PyData Theme
  • 🔧 Move notebooks to the docs source because this is easier in combination with the MyST parser.
  • 🔧 Switched to the MyST-NB as the content parser because it enables more features.
  • ✨ Enabled docs preview builds.

Click "details" to preview the documentation:

grafik

@michaelosthege michaelosthege self-assigned this Apr 23, 2024
@michaelosthege
Move notebooks to the docs sources
8a21679 
This should simplify the docs build a lot.
@michaelosthege michaelosthege marked this pull request as ready for review April 23, 2024 13:58
@michaelosthege michaelosthege mentioned this pull request Apr 23, 2024
Merged
@lhelleckes lhelleckes self-requested a review April 25, 2024 07:23
lhelleckes
lhelleckes approved these changes Apr 25, 2024
View reviewed changes
Copy link
Member

@lhelleckes lhelleckes left a comment

Choose a reason for hiding this comment

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

Looking good. Can I check the changes documentation somewhere without building it locally to see if something might be broken?

@michaelosthege
Copy link
Member Author

Looking good. Can I check the changes documentation somewhere without building it locally to see if something might be broken?

Yes, as described in the PR description :)

@lhelleckes
Copy link
Member

Maybe an unpopular opinion, but I liked the previous theme a bit more. This one is very white and I liked the left-hand menu before very much as an overview. :D

@lhelleckes
Copy link
Member

grafik

Also the empty section nvigation on the left is a bit sad on most pages.

@michaelosthege
Copy link
Member Author

you're right that the navigation is not as good as before.

The within-page navigation is now on the right, but the overall navigation is now only in the navbar.

@lhelleckes
Copy link
Member

Thanks for changing the theme! Navigation is much better now. Will merge :)

@lhelleckes lhelleckes merged commit da3f545 into master Apr 25, 2024
6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 25, 2024
@michaelosthege michaelosthege deleted the docs-modernization branch April 25, 2024 08:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@lhelleckes lhelleckes lhelleckes approved these changes

@bertramgeinitz bertramgeinitz Awaiting requested review from bertramgeinitz

Assignees

@michaelosthege michaelosthege

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@michaelosthege @lhelleckes