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

[docs] Add "Edit on GH" links, fix searchbox, widen viewport, better legibility #833

Merged
merged 8 commits into from
Mar 28, 2022
Merged

[docs] Add "Edit on GH" links, fix searchbox, widen viewport, better legibility #833

merged 8 commits into from
Mar 28, 2022

Commits on Mar 28, 2022

  1. docs: _isso theme: Simplify js macros, fix search 

    A few things got refactored in sphinx, especially for 4.x.
Therefore, use provided helpers.

As a reference for the future, always look at what the
"basic" sphinx theme (bundled as `sphinx/themes/basic`)
does.

See:
- sphinx-doc/sphinx@a957d6f710
- sphinx-doc/sphinx#4916
- sphinx-doc/sphinx#4915
- readthedocs/sphinx_rtd_theme#1021
    @ix5
    ix5 committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    59e397e View commit details
    Browse the repository at this point in the history

  2. Makefile: site target depends on css again

    @ix5
    ix5 committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    4682142 View commit details
    Browse the repository at this point in the history

  3. docs: _isso theme: Add searchbox in sidebar 

    This also necessitates a bit of CSS.
    @ix5
    ix5 committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    6689f85 View commit details
    Browse the repository at this point in the history

  4. docs: css: Darker colors, increased size 

    This increases legibility and improves contrast.
    @ix5
    ix5 committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    36e1f14 View commit details
    Browse the repository at this point in the history

  5. docs: Add 'Edit on GitHub' link 

    The implementation closely matches `sphinx-rtd-theme`,
see https://github.com/readthedocs/sphinx_rtd_theme/blob/9264091087620d421b0804c00937b00980ac3916/sphinx_rtd_theme/breadcrumbs.html#L19-L40
and https://github.com/readthedocs/sphinx_rtd_theme/blob/ef9a0584ef6d43f898a2b787a541e31a79f560e8/docs/configuring.rst#file-wide-metadata

GitHub svg icon taken from Wikipedia (Wikimedia Commons)

Usage: https://github.com/logos
> Do these awesome things:
> - Use the Octocat or GitHub logo to link to GitHub
> - Use the Mark in social buttons to link to your GitHub
>   profile or project
> - Use the Octocat or GitHub logo to advertise that your
>   product has built-in GitHub integration
> - Use the Octocat or GitHub logo in a blog post or news
>   article about GitHub
    @ix5
    ix5 committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    39e2e0e View commit details
    Browse the repository at this point in the history

  6. [nit] docs: index: Non-breaking space for GH Discussions 

    A name that's broken across two lines looks ugly
    @ix5
    ix5 committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    f256655 View commit details
    Browse the repository at this point in the history

  7. docs: css: Increase outer-container max-width to 80em

    @ix5
    ix5 committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    fd5eb3d View commit details
    Browse the repository at this point in the history

  8. docs: css: Bold nav items, increased letter-spacing

    @ix5
    ix5 committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    0c4ee17 View commit details
    Browse the repository at this point in the history