I find the typeface to be too thin for continuous pleasant reading and would consider something akin to Georgia (which Flask uses for example) to be better. It's also bigger, but the typeface definitely plays a larger role.

I suggest opening the images in new tabs for optimal viewing (github resized them).

source: http://docs.python-requests.org/en/master/

source: http://flask.pocoo.org/docs/0.10/errorhandling/

Fixes #18. I finally got annoyed enough at the feature not being there that I added it myself.

The links are optional, and off by default. Under theme options, set show_relbars = True to enable them.

The top and bottom bars can be individually toggled. The border color can also be customized. Documentation is also included.

Dear Jeff, congrats for your alabaster ext. I love it! I encounter problems in changing the ugly border of the bibliography entries (generated by sphinx-contrib-bibtex): they appear by default in tables with 1px border and I haven't succeeded in putting it without border (but I need that regular tables to keep their border as well). This might be changed in the theme.conf file. See end of this file: http://webcom.upmf-grenoble.fr/sciedu/pdessus/sapea/innovation.html Thx for your help in advance! best philippe

It'd be great if there were links to the previous and next posts in every page (where applicable).

(By the way, thanks for the theme! I like it a lot)

Hi

In commit a8c8b2cd3f8546245e36976ed2c12662b0fd4117 should this be:

with open('README.rst'), encoding='utf-8') as f:
    readme = f.read() 

I'm getting the following error when building using python3 (on the opensuse build server)

 python3 setup.py build
[   97s] Traceback (most recent call last):
[   97s]   File "setup.py", line 13, in <module>
[   97s]     readme = f.read()
[   97s]   File "/usr/lib64/python3.4/encodings/ascii.py", line 26, in decode
[   97s]     return codecs.ascii_decode(input, self.errors)[0]
[   97s] UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 15684: ordinal not in range(128)
[   97s] error: Bad exit status from /var/tmp/rpm-tmp.SU1PL3 (%build)

see https://build.opensuse.org/package/live_build_log/home:apersaud:branches:devel:languages:python3/python3-alabaster/openSUSE_13.2/x86_64

[@hynek] Nice, the alabaster theme is broken in Safari TP (and Safari TP only). http://attrs.readthedocs.io/en/latest/ is all italics to me. cc @bitprophet ... running Release 26 (Safari 10.2, WebKit 12604.1.12)

[@jgelens] hmm looks fine here, using the latest TP ... I don't have these fonts though, maybe it's with that? "'goudy old style', 'minion pro', 'bell mt'"

[@hynek] that’s my suspicion too. I’ve just checked, http://www.python-requests.org/en/master/ looks broken too. 🎉 Thanks Apple! ... yeah it’s something with goudy old style. removing it makes it look fine

So tl;dr if this isn't some odd TP-only bug that'll get fixed before release, Apple may have switched up fonts somehow, e.g.:

• the font-face normally selected by Safari on Hynek's Mac is now italic by default when it wasn't before
• Safari is now choosing a different font-face from our list than it used to - one that would have appeared as italics beforehand.
  • Which could possibly be the same as what Kenneth references in this comment: https://github.com/bitprophet/alabaster/issues/73#issuecomment-188608656 ?
  • Italics isn't the same as "really thin" but it's close enough to make me suspicious that the font just generally doesn't look good, assuming we find Hynek's Safari was not choosing Goudy before.

When either are set, adds a "Donate" section to the sidebar. If donate_url is set, a "donate" shield button is used. If opencollective is set, an OpenCollective button is used.

With donate_url = ""https://www.paypal.me/StevenLoria":

With opencollective = "marshmallow":

Both may be set:

I also removed the underlines from badges in the sidebar, which I assumed were inadvertent:

Before

After

Gratipay shut down at the end of 2017. It's a shame because open source sustainability is an important topic. Perhaps instead of removing donate.html, we could extend it to support patreon and open collective? (are there other services?)

Not sure if this issue should go to sphinx itself, but the new recommendation to use alabaster in 1.3 causes some unexpected behavior with domains providing indices: the navigation div is not visible with alabaster, unlike in classic.

For example the httpdomain creates a routing table page, and links to it in the navigation div:

<div class="related" role="navigation" aria-label="related navigation">
  <h3>Navigation</h3>
  <ul>
    <li class="right" style="margin-right: 10px">
      <a href="genindex.html" title="General Index"
         accesskey="I">index</a></li>
    <li class="right" >
      <a href="http-routingtable.html" title="HTTP Routing Table"
         >routing table</a> |</li>
  </ul>
</div>

I wrote this docstring:

def bar(age):
    """
    this is bar function

    >>> import foo
    >>> foo.bar(10)
    10

    This function just return age.

    :param int age: your age
    :return: age
    :rtype: int
    """
    return age

and built with using 'classic' theme, I got this image:

I git this image with using 'alabaster' theme:

It would be better to understand the document if gray box for doctest lines doesn't protrude outside the docstring content area.

• macOS Monterey
• Chrome 95
• Chrome Canary 98
• Opera 71 (also Chromium)

The CSS uses hyphens: auto which inserts hyphens for some words, however with the hyphen shows as an empty box aka "tofu":

https://alabaster.readthedocs.io/en/latest/changelog.html

Non-Chromium browsers such as Firefox 94 (pictured here) and Safari 15.1 are fine:

Also reported to Chromium: https://bugs.chromium.org/p/chromium/issues/detail?id=1270110

Bumps wheel from 0.24 to 0.38.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Alabaster supports Google Analytics UA via 'analytics_id' options. This will be deprecated in summer 2023, and for a new account, you have to jump through hoops to even get a UA id if you do not already have one, it is not at all simple. Even if you do this, it is basically a dual GA4/UA account, and kinda messy.

https://support.google.com/analytics/answer/9304153

This site explains the setup of an account, and then the section on 'Add the Google tag directly to your webpages' explains what you need to do. They have some site types where it seems like it can automatically add, and for others it gives manual instructions.

I was successfully able to get this to work by adding it into the layout.html included with Alabaster as shown:

{%- set theme_show_relbar_top = theme_show_relbar_top or theme_show_relbars %}
{%- set theme_show_relbar_bottom = theme_show_relbar_bottom or theme_show_relbars %}

{# removed existing top+bottom related nav, and embed in main content #}
{%- block relbar1 %}{% endblock %}
{%- block relbar2 %}{% endblock %}

{# Nav should appear before content, not after #}
{%- block content %}
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-3ZFF0CWSJN"></script>
        <script>
                                  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'G-XXXXXXX');
        </script>
{%- if theme_fixed_sidebar|lower == 'true' %}
  <div class="document">
    {{ sidebar() }}
    {%- block document %}

what is in there as ''G-XXXXXXX' should be the GA4 analytics_id to be used, so would need to be a configurable option.

If you look at the theme, in a mobile mode, you will see that the markers (which are squares) of the nested menu items are black (or some very dark color), which is the same color as the background of the menu in that case, so that makes the markers not very visible. Either we can get rid of the markers or change the color to something more visible with that background.

Having <h1> inside <p> led some browsers (e.g., Firefox) to believe that the HTML code was ill-formed. Thus, they inserted </p> before <h1>, causing the logo to be incorrectly pushed away from the logo name. Below are screenshots showing the issue.

Before the pull request:

After the pull request:

In definition lists, dt and dd entries are slightly misaligned. https://github.com/bitprophet/alabaster/blob/6a0a56ffe79bd039085e1ad7ed26da5b217bd4ab/alabaster/static/alabaster.css_t#L279-L281 Adding div.body dt to the list of selected items above will fix this. Using alabaster v0.7.12 and sphinx v4.5.0.