Skip to content

Commit 92bc1c2

Browse files
drammockdrammock
committed
standardize component descriptions
1 parent bb1a607 commit 92bc1c2

18 files changed

+18
-18
lines changed

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Breadcrumb to display information on the navigation hierarchy. #}
1+
{# Displays (and links to) the parent section(s) of the currently viewed page. #}
22
{%- block breadcrumbs %}
33
{#
44
If we have more than 3 parents (excluding the home page) then we remove

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/copyright.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# The component to display the copyrights informations set in conf.py. #}
1+
{# Displays the copyright information (which is defined in conf.py). #}
22
{% if show_copyright and copyright %}
33
<p class="copyright">
44
{% if hasdoc('copyright') %}

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/edit-this-page.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# A link to the edit interface of the page source in the specified VCS. #}
1+
{# Displays a link to the edit interface of the page source in the specified Version Control System. #}
22
{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %}
33
{% set src = sourcename.split('.') %}
44
<div class="tocsection editthispage">

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/icon-links.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Display the icons link as inline blocks in the navbar. #}
1+
{# Displays icon-links as list items. #}
22
{%- macro icon_link_nav_item(url, icon, name, type, attributes='') -%}
33
{%- if url | length > 2 %}
44
<li class="nav-item">

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/indices.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# add the indies generated from Sphinx. #}
1+
{# Displays links to the Sphinx-generated indices (genindex, modindex, py-modindex). #}
22
<nav class="sidebar-indices-items">
33
<p class="sidebar-indices-items__title" role="heading" aria-level="1">{{ _("Indices") }}</p>
44
<ul class="indices-link">

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/last-updated.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Display the last time a page have been updated #}
1+
{# Displays the date and time that the documentation was last built. #}
22
{%- if last_updated -%}
33
<p class="last-updated">
44
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-icon-links.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Display the icons link as inline blocks in the navbar. #}
1+
{# Displays icon-links in the header navbar. #}
22
{%- block icon_links -%}
33
{%- include "icon-links.html" with context -%}
44
{%- endblock icon_links %}

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-logo.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# The logo of your documentation. #}
1+
{# Displays the logo of your documentation site, in the header navbar. #}
22
{# Logo link generation -#}
33
{% if not theme_logo.get("link") %}
44
{% set href = pathto(root_doc) %}

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# The links of the first level toctree displayed in the header navbar. #}
1+
{# Displays links to the top-level TOCtree elements, in the header navbar. #}
22
<nav class="navbar-nav">
33
<p class="sidebar-header-items__title"
44
role="heading"

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/page-toc.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Display the current page TOC. #}
1+
{# Displays the current page's Table of Contents. #}
22
{% set page_toc = generate_toc_html() %}
33
{%- if page_toc | length >= 1 %}
44
<div class="page-toc tocsection onthispage">

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/prev-next.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Previous / next buttons. #}
1+
{# Displays links to the previous and next page in the TOCtree order. #}
22
<div class="prev-next-area">
33
{%- if prev %}
44
<a class="left-prev"

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-button-field.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Behaves the same as `search-button.html` but looks more like a search field. #}
1+
{# Displays a search field image that opens a search overlay when clicked. #}
22
{# As this function will only work when JavaScript is enabled, we add it through JavaScript. #}
33
<script>
44
document.write(`

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-button.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# A button that, when clicked, will trigger a search popup overlay. #}
1+
{# Displays a magnifying glass icon that opens a search overlay when clicked. #}
22
{# As this function will only work when JavaScript is enabled, we add it through JavaScript. #}
33
<script>
44
document.write(`

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-field.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# A bootstrap-styled field that will direct to the `search.html` page when submitted. #}
1+
{# Displays an interactive search field directly on the page. #}
22
<form class="bd-search d-flex align-items-center"
33
action="{{ pathto('search') }}"
44
method="get">

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/searchbox.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
{# div#searchbox hosts the "Hide Search Matches" link #}
1+
{# An empty container that holds the "Hide Search Matches" button when it's needed. #}
22
<div id="searchbox"></div>

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/sidebar-ethical-ads.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Placeholder where the ReadTheDocs ethical ads will be placed. #}
1+
{# For sites hosted on ReadTheDocs, displays "ethical ads". #}
22
{% if READTHEDOCS %}
33
<div id="ethical-ad-placement"
44
class="flat"

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/sidebar-nav-bs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# Add the toctree of each page included under the selected Heading 1 from header navbar. #}
1+
{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. #}
22
<nav class="bd-docs-nav bd-links"
33
aria-label="{{ _('Section Navigation') }}">
44
<p class="bd-links__title" role="heading" aria-level="1">{{ _("Section Navigation") }}</p>

‎src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/sourcelink.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{# If enabled, create a button to display the .rst source of the displayed page. #}
1+
{# Displays a link to the .rst source of the current page. #}
22
{% if show_source and has_source and sourcename %}
33
<div class="tocsection sourcelink">
44
<a href="{{ pathto('_sources/' + sourcename, true)|e }}">

0 commit comments

Comments
 (0)