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

docs: refresh docs with the PyData Sphinx theme (MVP) #2300

Merged
merged 21 commits into from
Sep 20, 2024

Conversation

vytas7
Copy link
Member

@vytas7 vytas7 commented Aug 26, 2024

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.

@vytas7 vytas7 requested review from kgriffs and CaselIT August 26, 2024 07:27
Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b29fd55) to head (3510d80).
Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

@vytas7 vytas7 marked this pull request as ready for review September 17, 2024 19:12
@vytas7 vytas7 changed the title docs: refresh docs with the PyData Sphinx theme [WORK IN PROGRESS] docs: refresh docs with the PyData Sphinx theme (MVP) Sep 17, 2024
@vytas7
Copy link
Member Author

vytas7 commented Sep 17, 2024

Unfortunately we'll need to cut corners in order to ensure a timely release.
The new theme probably already looks better or at least on par with the old (i.e., current) one, so maybe we can :shipit:
And iterate on it further in the 4.x cycle.

Copy link
Member

@CaselIT CaselIT left a 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

@CaselIT
Copy link
Member

CaselIT commented Sep 17, 2024

Tried it.

  • dark theme looks fine as it is, no need to delay it
  • Not sure how to, but I don't think the summary at the top of the page is needed now, since it's in the right side. I mean the highlighted part
    image
    this is generated by the .. contents:: :local: directive

@CaselIT
Copy link
Member

CaselIT commented Sep 19, 2024

@vytas7 what do you think about removing .. contents:: :local: ?

@vytas7
Copy link
Member Author

vytas7 commented Sep 19, 2024

I'll take a look at these tables of contents, IIRC there are many options to achieve what we want, hidden ToC, etc.

@CaselIT
Copy link
Member

CaselIT commented Sep 19, 2024

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

@vytas7
Copy link
Member Author

vytas7 commented Sep 19, 2024

Removed these local ToCs, and updated the Falcon Pygments theme, esp the falconry-dark style.

@vytas7 vytas7 requested a review from CaselIT September 19, 2024 13:06
@CaselIT
Copy link
Member

CaselIT commented Sep 19, 2024

we have some manual toc in app.rst and other. will push an update.

let me know if it works for you 3510d80

@vytas7 vytas7 merged commit 9f47efb into falconry:master Sep 20, 2024
37 checks passed
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.

Enable the dark theme for docs Docs facelift
2 participants