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: update dependencies #4610

Merged
merged 2 commits into from
Jun 20, 2022
Merged

Conversation

bastimeyer
Copy link
Member

This updates the furo theme to the latest version and adds an edit button and scroll-to-top button. Except for some minor details, everything should stay the same, but please check thoroughly before merging.

Noticeable changes

  • CLI arguments and API reference are displayed much clearer
  • Code highlighting colors are different
  • Some tables don't define a colgroup anymore and have thus different sizes

This also replaces recommonmark (abandoned project) with myst-parser for parsing markdown (changelog). No differences here.

And sphinx gets set to >=4.0.0, which was already a requirement of the previously used version of furo. Sphinx 5.0.0 does not have any interesting changes, and both furo and myst-parser require at least 4.0.0. We've been using the latest version the whole time, so this is only relevant for packagers who package offline documentation.


- Bump min version of Sphinx to 4.0.0
  This was already required by the previous version of furo
- Revert headline font sizes, font weights and margins to previous style
- Fix broken margin of version links in sidebar
- Override font style of pygments' "generic output"
- Add edit page button via new config option
@bastimeyer
Copy link
Member Author

@gravyboat
Copy link
Member

Text color choices are clearer on the new one which is nice as is the spacing. Only thing I noticed while browsing around is that the github and issues buttons no longer look like buttons, but are just links:
broken_icons

I don't think it's problematic enough to avoid blocking this merge however.

@mkbloke
Copy link
Member

mkbloke commented Jun 19, 2022

Only thing I noticed while browsing around is that the github and issues buttons no longer look like buttons, but are just links

That's different to what I see. In Firefox 101.0.1 they are both showing like this for me:

menu

@bastimeyer
Copy link
Member Author

The GH buttons have not been changed. Their data, including stylesheets, gets loaded from a JS snippet, as you can see here:
https://github.com/bastimeyer/streamlink/blame/docs/update-deps/docs/_templates/sidebar/github-buttons.html

@gravyboat gravyboat merged commit 1c1dbf4 into streamlink:master Jun 20, 2022
@bastimeyer bastimeyer deleted the docs/update-deps branch June 20, 2022 04:43
Billy2011 added a commit to Billy2011/streamlink-27 that referenced this pull request Jul 12, 2022
- Bump min version of Sphinx to 4.0.0
  This was already required by the previous version of furo
- Revert headline font sizes, font weights and margins to previous style
- Fix broken margin of version links in sidebar
- Override font style of pygments' "generic output"
- Add edit page button via new config option
Billy2011 added a commit to Billy2011/streamlink-27 that referenced this pull request Jul 12, 2022
Billy2011 added a commit to Billy2011/streamlink-27 that referenced this pull request Jul 12, 2022
- Bump min version of Sphinx to 4.0.0
  This was already required by the previous version of furo
- Revert headline font sizes, font weights and margins to previous style
- Fix broken margin of version links in sidebar
- Override font style of pygments' "generic output"
- Add edit page button via new config option
Billy2011 added a commit to Billy2011/streamlink-27 that referenced this pull request Jul 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants