Skip to content

Commit

Permalink
Run linkcheck and resolve issues with links
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Jan 8, 2024
1 parent 5e7189f commit 880804d
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 17 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,23 @@
:alt: Documentation Status

.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://opensource.org/licenses/BSD-3-Clause
:target: https://opensource.org/license/BSD-3-Clause
:alt: BSD 3 Clause


What is Alabaster?
==================

Alabaster is a visually (c)lean, responsive, configurable theme for the `Sphinx
<http://sphinx-doc.org>`_ documentation system.
<https://www.sphinx-doc.org>`_ documentation system.
It requires Python 3.9 or newer and Sphinx 3.4 or newer.

It began as a third-party theme, and is still maintained separately, but as of
Sphinx 1.3, Alabaster is an install-time dependency of Sphinx and is selected
as the default theme.

Live examples of this theme can be seen on `this project's own website
<https://alabaster.readthedocs.io/>`_, `paramiko.org <http://paramiko.org>`_,
`fabfile.org <http://fabfile.org>`_ and `pyinvoke.org <http://pyinvoke.org>`_.
<https://alabaster.readthedocs.io/>`_, `paramiko.org <https://www.paramiko.org>`_,
`fabfile.org <https://www.fabfile.org>`_ and `pyinvoke.org <https://www.pyinvoke.org>`_.

For more documentation, please see https://alabaster.readthedocs.io/.
6 changes: 3 additions & 3 deletions alabaster/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@
{% if show_copyright %}&copy;{{ copyright }}.{% endif %}
{% if show_sphinx %}
{% if show_copyright %}|{% endif %}
Powered by <a href="http://sphinx-doc.org/">Sphinx {{ sphinx_version }}</a>
&amp; <a href="https://github.com/sphinx-doc/alabaster">Alabaster {{ alabaster_version }}</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx {{ sphinx_version }}</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster {{ alabaster_version }}</a>
{% endif %}
{%- if show_source and has_source and sourcename %}
{% if show_copyright or show_sphinx %}|{% endif %}
Expand All @@ -115,7 +115,7 @@

(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();

Expand Down
2 changes: 1 addition & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Next release (in development)
Solà.
- Fix a handful of mismatched/unclosed HTML tags in the templates. Thanks to
Marvin Pinto for catch & patch.
- Add `Codecov <https://codecov.io>`_ badge support to sidebar.
- Add `Codecov <https://about.codecov.io>`_ badge support to sidebar.

:git_tag:`0.7.6` -- 2015-06-22
------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Settings related to text display, logo, etc.
(if there is any.)
* ``canonical_url``: If set, is used as the base URL (set before the relative
path/pagename) for a ``<link rel="canonical">`` `canonical URL
<https://support.google.com/webmasters/answer/139066?rd=1>`_ header tag.
<https://developers.google.com/search/docs/crawling-indexing/consolidate-duplicate-urls>`_ header tag.

.. note:: This value must end with a trailing slash.

Expand Down Expand Up @@ -113,7 +113,7 @@ banners.
* ``badge_branch``: Set which branch is used in the Travis, CodeCov, etc
badges.
* ``codecov_button``: ``true``, ``false`` or a Github-style ``"account/repo"``
string - used to display a `Codecov <https://codecov.io>`_ build status
string - used to display a `Codecov <https://about.codecov.io>`_ build status
button in the sidebar. If ``true``, uses your ``github_(user|repo)``
settings.
* ``donate_url``: URL to generic/arbitrary donation service; causes display of
Expand Down Expand Up @@ -176,7 +176,7 @@ Sidebar-related options that aren't directly related to service links.
* ``sidebar_collapse``: Boolean determining whether all TOC entries that
are not ancestors of the current page are collapsed.
You can read more about this in the Sphinx toctree
`docs <https://www.sphinx-doc.org/en/stable/templating.html#toctree>`_.
`docs <https://www.sphinx-doc.org/en/master/development/templating.html#toctree>`_.
* ``sidebar_includehidden``: Boolean determining whether the TOC sidebar
should include hidden Sphinx toctree elements. Defaults to ``true`` so you
can use ``:hidden:`` in your index page's root toctree & avoid having 2x
Expand Down
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Features
========

* Easy ability to install/use as a Python package (tip o' the hat to `Dave &
Eric's sphinx_rtd_theme <https://github.com/snide/sphinx_rtd_theme>`_ for
Eric's sphinx_rtd_theme <https://github.com/readthedocs/sphinx_rtd_theme>`_ for
showing the way);
* Style tweaks compared to the source themes, such as better code-block
alignment, Github button placement, page source link moved to footer,
Expand All @@ -23,10 +23,10 @@ Project background

Alabaster is a modified (with permission) version of `Kenneth Reitz's
<https://www.kennethreitz.org/>`_ `"krTheme" Sphinx theme
<https://github.com/kennethreitz/kr-sphinx-themes>`_ (it's the one used
in his `Requests <http://python-requests.org>`_ project). Kenneth's
<https://github.com/kennethreitz-archive/kr-sphinx-themes>`_ (it's the one used
in his `Requests <https://requests.readthedocs.io/>`_ project). Kenneth's
theme was itself originally based on Armin Ronacher's `Flask
<http://flask.pocoo.org/>`_ theme. Many thanks to both for their hard work.
<https://flask.palletsprojects.com/>`_ theme. Many thanks to both for their hard work.


Implementation notes
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ assuming you'll always have ``about.html`` activated, but otherwise it doesn't
care much.

* See `the Sphinx docs
<http://sphinx-doc.org/config.html#confval-html_sidebars>`_ for details on
<https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars>`_ for details on
how this setting behaves.
* Alabaster provides ``about.html`` (logo, github button + blurb),
``donate.html`` (donation/support buttons/links) and ``navigation.html`` (a
Expand All @@ -60,7 +60,7 @@ If you're using any of the image-related options listed on :doc:`customization`
you'll also want to tell Sphinx where to get these files from. If so, add a
line like this (changing the path if necessary; see `the Sphinx docs for
'html_static_path'
<http://sphinx-doc.org/config.html?highlight=static#confval-html_static_path>`_) to your ``conf.py``:
<https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_static_path>`_) to your ``conf.py``:

.. code-block:: python
Expand Down

0 comments on commit 880804d

Please sign in to comment.