-
-
Notifications
You must be signed in to change notification settings - Fork 944
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
docs: refresh docs with the PyData Sphinx theme (MVP) #2300
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2300 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 63 63
Lines 7539 7539
Branches 1281 1281
=========================================
Hits 7539 7539 ☔ View full report in Codecov by Sentry. |
Unfortunately we'll need to cut corners in order to ensure a timely release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
code looks ok, will try it.
Personally I think instead of disabling the dark them we should instead just keep the pydata default. If we have time to improve it we can do that later, but the builtin dark theme is good enough to have available if people prefer it
@vytas7 what do you think about removing |
I'll take a look at these tables of contents, IIRC there are many options to achieve what we want, hidden ToC, etc. |
I mentioned removing it since there is now the TOC on the right side already, and having it also at the top seems a bit of an unnecessary duplication |
Removed these local ToCs, and updated the Falcon Pygments theme, esp the |
we have some manual toc in app.rst and other. will push an update. let me know if it works for you 3510d80 |
Fixes #2198.
Closes #2332.
Logotype is just a placeholder, we need to create a proper one.
Tabs need rework, it would be better to use
sphinx_design
's tabs, not the current module we're using, since it plays better with the PyData theme: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/web-components.html#tabs.We also need to rework how table of contents is shown on pages, because PyData in general works a bit differently from Alabaster. I saw other projects hiding the ToC in some cases so that it is only summarized on the side bar on the left side, and then one tunes the landing page separately.