ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs#9876

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

Closed
jorisvandenbossche wants to merge 10 commits into from
Closed

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs #9876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a88f933
ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx…
jorisvandenbossche Apr 2, 2021
894526f
replace sphinx_rtd_theme -> pydata-sphinx-theme
jorisvandenbossche Apr 2, 2021
7cbdc5e
fix css for logo img on chrome
jorisvandenbossche Apr 2, 2021
6d70e0e
remove sphinx in-page content sidebar
jorisvandenbossche Apr 2, 2021
533d76c
fix sidebar / footer overlap
jorisvandenbossche Apr 2, 2021
486ee5e
more uniform colors
jorisvandenbossche Apr 6, 2021
aa8e496
center footer
jorisvandenbossche Apr 6, 2021
ed430a9
fine-tune sidebar height
jorisvandenbossche Apr 13, 2021
0910020
limit sidebar expanding for Pytho API section
jorisvandenbossche Apr 15, 2021
2ecc7a4
fix a few sphinx warnings
jorisvandenbossche Apr 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ci/conda_env_sphinx.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,4 @@ doxygen
ipython
# Pinned per ARROW-9693
sphinx=3.1.2
sphinx_rtd_theme
pydata-sphinx-theme
2 changes: 1 addition & 1 deletion ci/docker/linux-apt-docs.dockerfile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@ RUN pip install \
breathe \
ipython \
sphinx \
sphinx_rtd_theme
pydata-sphinx-theme

COPY c_glib/Gemfile /arrow/c_glib/
RUN gem install --no-document bundler && \
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@ breathe
ipython
numpydoc
sphinx==2.4.4
sphinx_rtd_theme
pydata-sphinx-theme
Binary file addeddocs/source/_static/arrow.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/source/_static/favicon.ico
View file
Open in desktop
Binary file not shown.
53 changes: 53 additions & 0 deletions docs/source/_static/theme_overrides.css
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,59 @@
* under the License.
*/


/* Customizing with theme CSS variables */

:root {
--pst-color-active-navigation: 215, 70, 51;
--pst-color-link-hover: 215, 70, 51;
--pst-color-headerlink: 215, 70, 51;
/* Use normal text color (like h3, ..) instead of primary color */
--pst-color-h1: var(--color-text-base);
--pst-color-h2: var(--color-text-base);
/* Use softer blue from bootstrap's default info color */
--pst-color-info: 23, 162, 184;
--pst-header-height: 0px;
}

code {
color: rgb(215, 70, 51);
}

.footer {
text-align: center;
}

/* Ensure the logo is properly displayed */

.navbar-brand {
height: auto;
width: auto;
}

a.navbar-brand img {
height: auto;
width: auto;
max-height: 15vh;
max-width: 100%;
}


/* Limit the max height of the sidebar navigation section. Because in our
custimized template, there is more content above the navigation, i.e.
larger logo: if we don't decrease the max-height, it will overlap with
the footer.
Details: min(15vh, 110px) for the logo size, 8rem for search box etc*/

@media (min-width:720px) {
@supports (position:-webkit-sticky) or (position:sticky) {
.bd-links {
max-height: calc(100vh - min(15vh, 110px) - 8rem)
}
}
}


/* Fix table text wrapping in RTD theme,
* see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
*/
Expand Down
19 changes: 19 additions & 0 deletions docs/source/_templates/docs-sidebar.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>

<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
{% if "python/api" in pagename or "python/generated" in pagename %}
{{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
{% else %}
{{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
{% endif %}
</div>
</nav>
14 changes: 3 additions & 11 deletions docs/source/_templates/layout.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{% extends "pydata_sphinx_theme/layout.html" %}

{%- block footer %}
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'UA-107500873-1');
</script>
{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}
14 changes: 9 additions & 5 deletions docs/source/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,14 +179,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
'nosidebar': True
"show_toc_level": 2,
"google_analytics_id": "UA-107500873-1",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All@@ -204,13 +205,13 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = "_static/arrow.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
# html_favicon = None
html_favicon = "_static/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand DownExpand Up@@ -239,7 +240,10 @@

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
html_sidebars = {
# '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
'**': ['docs-sidebar.html'],
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/api/array.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Arrays
======

.. sidebar:: Contents

.. contents:: :local:

.. doxygenclass:: arrow::Array
:project: arrow_cpp
:members:
Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/api/compute.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,6 @@
Compute Functions
=================

.. sidebar:: Contents

.. contents:: :local:

Datum class
-----------

Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/api/dataset.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Dataset
=======

.. sidebar:: Contents

.. contents:: :local:

Interface
=========

Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/api/filesystem.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Filesystems
===========

.. sidebar:: Contents

.. contents:: :local:

Interface
=========

Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/api/io.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Input / output
==============

.. sidebar:: Contents

.. contents:: :local:

Interfaces
==========

Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/api/ipc.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,10 +22,6 @@
Arrow IPC
=========

.. sidebar:: Contents

.. contents:: :local:

IPC options
===========

Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/compute.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@
Compute Functions
=================

.. sidebar:: Contents

.. contents:: :local:

The generic Compute API
=======================

Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/memory.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,6 @@ Memory Management
.. seealso::
:doc:`Memory management API reference <api/memory>`

.. sidebar:: Contents

.. contents:: :local:

Buffers
=======

Expand Down
4 changes: 0 additions & 4 deletions docs/source/cpp/parquet.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,6 @@ Reading and writing Parquet files
.. seealso::
:ref:`Parquet reader and writer API reference <cpp-api-parquet>`.

.. sidebar:: Contents

.. contents:: :local:

The `Parquet format <https://parquet.apache.org/documentation/latest/>`__
is a space-efficient columnar storage format for complex data. The Parquet
C++ implementation is part of the Apache Arrow project and benefits
Expand Down
2 changes: 1 addition & 1 deletion docs/source/developers/cpp/windows.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ to the Unix-specific ``ccache``).
Newer versions of Visual Studio include Ninja. To see if your Visual Studio
includes Ninja, run the initialization command shown
:ref:`above<windows-system-setup>` (``vcvarsall.bat`` or ``VsDevCmd.bat``), then
run ``ninja --version``.
run ``ninja --version``.

If Ninja is not included in your version of Visual Studio, and you are using
conda, activate your conda environment and install Ninja and clcache:
Expand Down
2 changes: 2 additions & 0 deletions docs/source/format/Guidelines.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Implementation Guidelines
=========================

Expand Down
2 changes: 2 additions & 0 deletions docs/source/format/IPC.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

IPC
===

Expand Down
2 changes: 2 additions & 0 deletions docs/source/format/Layout.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Physical Memory Layout
======================

Expand Down
2 changes: 2 additions & 0 deletions docs/source/format/Metadata.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Format Metadata
===============

Expand Down
3 changes: 0 additions & 3 deletions docs/source/python/plasma.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,6 @@
The Plasma In-Memory Object Store
=================================

.. contents:: Contents
:depth: 3

.. note::

As present, Plasma is only supported for use on Linux and macOS.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/dataset.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -517,8 +517,8 @@ def dataset(source, schema=None, format=None, filesystem=None,

Parameters
----------
source : path, list of paths, dataset, list of datasets, (list of) batches
or tables, iterable of batches, RecordBatchReader, or URI
source : path, list of paths, dataset, list of datasets, (list of) batches\
or tables, iterable of batches, RecordBatchReader, or URI
Path pointing to a single file:
Open a FileSystemDataset from a single file.
Path pointing to a directory:
Expand Down
8 changes: 4 additions & 4 deletions python/pyarrow/parquet.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -547,8 +547,8 @@ def _sanitize_table(table, new_schema, flavor):
LogicalTypes.md#nested-types>`_, defaults to ``False``.
For ``use_compliant_nested_type=True``, this will write into a list
with 3-level structure where the middle level, named ``list``,
is a repeated group with a single field named ``element``
::
is a repeated group with a single field named ``element``::

<list-repetition> group <name> (LIST) {
repeated group list {
<element-repetition> <element-type> element;
Expand All@@ -558,8 +558,8 @@ def _sanitize_table(table, new_schema, flavor):
For ``use_compliant_nested_type=False``, this will also write into a list
with 3-level structure, where the name of the single field of the middle
level ``list`` is taken from the element name for nested columns in Arrow,
which defaults to ``item``
::
which defaults to ``item``::

<list-repetition> group <name> (LIST) {
repeated group list {
<element-repetition> <element-type> item;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs#9876

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

 Closed

jorisvandenbossche
wants to merge
10
commits into

from

 Closed


ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs
#9876
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
a88f933

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx…


jorisvandenbossche Apr 2, 2021
894526f

replace sphinx_rtd_theme -> pydata-sphinx-theme


jorisvandenbossche Apr 2, 2021
7cbdc5e

fix css for logo img on chrome


jorisvandenbossche Apr 2, 2021
6d70e0e

remove sphinx in-page content sidebar


jorisvandenbossche Apr 2, 2021
533d76c

fix sidebar / footer overlap


jorisvandenbossche Apr 2, 2021
486ee5e

more uniform colors


jorisvandenbossche Apr 6, 2021
aa8e496

center footer


jorisvandenbossche Apr 6, 2021
ed430a9

fine-tune sidebar height


jorisvandenbossche Apr 13, 2021
0910020

limit sidebar expanding for Pytho API section


jorisvandenbossche Apr 15, 2021
2ecc7a4

fix a few sphinx warnings


jorisvandenbossche Apr 15, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/conda_env_sphinx.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,4 @@ doxygen
ipython
# Pinned per ARROW-9693
sphinx=3.1.2
sphinx_rtd_theme
pydata-sphinx-theme

2 changes: 1 addition & 1 deletion
ci/docker/linux-apt-docs.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@ RUN pip install \
 breathe \
 ipython \
 sphinx \
sphinx_rtd_theme
pydata-sphinx-theme

COPY c_glib/Gemfile /arrow/c_glib/
RUN gem install --no-document bundler && \
Expand Down

2 changes: 1 addition & 1 deletion
docs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@ breathe
ipython
numpydoc
sphinx==2.4.4
sphinx_rtd_theme
pydata-sphinx-theme
Binary file addeddocs/source/_static/arrow.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/source/_static/favicon.ico

View file


Open in desktop


Binary file not shown.


53 changes: 53 additions & 0 deletions
docs/source/_static/theme_overrides.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,59 @@
 * under the License.
 */


/* Customizing with theme CSS variables */

:root {
 --pst-color-active-navigation: 215, 70, 51;
 --pst-color-link-hover: 215, 70, 51;
 --pst-color-headerlink: 215, 70, 51;
 /* Use normal text color (like h3, ..) instead of primary color */
 --pst-color-h1: var(--color-text-base);
 --pst-color-h2: var(--color-text-base);
 /* Use softer blue from bootstrap's default info color */
 --pst-color-info: 23, 162, 184;
 --pst-header-height: 0px;
}

code {
 color: rgb(215, 70, 51);
}

.footer {
 text-align: center;
}

/* Ensure the logo is properly displayed */

.navbar-brand {
 height: auto;
 width: auto;
}

a.navbar-brand img {
 height: auto;
 width: auto;
 max-height: 15vh;
 max-width: 100%;
}


/* Limit the max height of the sidebar navigation section. Because in our
custimized template, there is more content above the navigation, i.e.
larger logo: if we don't decrease the max-height, it will overlap with
the footer.
Details: min(15vh, 110px) for the logo size, 8rem for search box etc*/

@media (min-width:720px) {
 @supports (position:-webkit-sticky) or (position:sticky) {
 .bd-links {
 max-height: calc(100vh - min(15vh, 110px) - 8rem)
 }
 }
}


/* Fix table text wrapping in RTD theme,
 * see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
 */
Expand Down

19 changes: 19 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>

<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
 <div class="bd-toc-item active">
 {% if "python/api" in pagename or "python/generated" in pagename %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
 {% else %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
 {% endif %}
 </div>
</nav>

14 changes: 3 additions & 11 deletions
docs/source/_templates/layout.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{% extends "pydata_sphinx_theme/layout.html" %}

{%- block footer %}
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
 window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());

 gtag('config', 'UA-107500873-1');
</script>
{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}

14 changes: 9 additions & 5 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,14 +179,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
 'nosidebar': True
 "show_toc_level": 2,
 "google_analytics_id": "UA-107500873-1",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All@@ -204,13 +205,13 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = "_static/arrow.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
# html_favicon = None
html_favicon = "_static/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand DownExpand Up@@ -239,7 +240,10 @@

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
html_sidebars = {
# '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
 '**': ['docs-sidebar.html'],
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/array.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Arrays
======

.. sidebar:: Contents

 .. contents:: :local:

.. doxygenclass:: arrow::Array
 :project: arrow_cpp
 :members:
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

Datum class
-----------

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/dataset.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Dataset
=======

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/filesystem.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Filesystems
===========

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/io.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Input / output
==============

.. sidebar:: Contents

 .. contents:: :local:

Interfaces
==========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/ipc.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,10 +22,6 @@
Arrow IPC
=========

.. sidebar:: Contents

 .. contents:: :local:

IPC options
===========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

The generic Compute API
=======================

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/memory.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,6 @@ Memory Management
.. seealso::
 :doc:`Memory management API reference <api/memory>`

.. sidebar:: Contents

 .. contents:: :local:

Buffers
=======

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/parquet.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,6 @@ Reading and writing Parquet files
.. seealso::
 :ref:`Parquet reader and writer API reference <cpp-api-parquet>`.

.. sidebar:: Contents

 .. contents:: :local:

The `Parquet format <https://parquet.apache.org/documentation/latest/>`__
is a space-efficient columnar storage format for complex data. The Parquet
C++ implementation is part of the Apache Arrow project and benefits
Expand Down

2 changes: 1 addition & 1 deletion
docs/source/developers/cpp/windows.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ to the Unix-specific ``ccache``).
Newer versions of Visual Studio include Ninja. To see if your Visual Studio
includes Ninja, run the initialization command shown
:ref:`above<windows-system-setup>` (``vcvarsall.bat`` or ``VsDevCmd.bat``), then
run ``ninja --version``.
run ``ninja --version``.

If Ninja is not included in your version of Visual Studio, and you are using
conda, activate your conda environment and install Ninja and clcache:
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Guidelines.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Implementation Guidelines
=========================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/IPC.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

IPC
===

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Layout.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Physical Memory Layout
======================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Metadata.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Format Metadata
===============

Expand Down

3 changes: 0 additions & 3 deletions
docs/source/python/plasma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,6 @@
The Plasma In-Memory Object Store
=================================

.. contents:: Contents
 :depth: 3

.. note::

 As present, Plasma is only supported for use on Linux and macOS.
Expand Down

4 changes: 2 additions & 2 deletions
python/pyarrow/dataset.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,8 +517,8 @@ def dataset(source, schema=None, format=None, filesystem=None,

 Parameters
 ----------
 source : path, list of paths, dataset, list of datasets, (list of) batches
or tables, iterable of batches, RecordBatchReader, or URI
 source : path, list of paths, dataset, list of datasets, (list of) batches\
or tables, iterable of batches, RecordBatchReader, or URI
 Path pointing to a single file:
 Open a FileSystemDataset from a single file.
 Path pointing to a directory:
Expand Down

8 changes: 4 additions & 4 deletions
python/pyarrow/parquet.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -547,8 +547,8 @@ def _sanitize_table(table, new_schema, flavor):
 LogicalTypes.md#nested-types>`_, defaults to ``False``.
 For ``use_compliant_nested_type=True``, this will write into a list
 with 3-level structure where the middle level, named ``list``,
 is a repeated group with a single field named ``element``
 ::
 is a repeated group with a single field named ``element``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> element;
Expand All@@ -558,8 +558,8 @@ def _sanitize_table(table, new_schema, flavor):
 For ``use_compliant_nested_type=False``, this will also write into a list
 with 3-level structure, where the name of the single field of the middle
 level ``list`` is taken from the element name for nested columns in Arrow,
 which defaults to ``item``
 ::
 which defaults to ``item``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> item;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs#9876

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

 Closed

jorisvandenbossche
wants to merge
10
commits into

from

 Closed


ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs
#9876
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
a88f933

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx…


jorisvandenbossche Apr 2, 2021
894526f

replace sphinx_rtd_theme -> pydata-sphinx-theme


jorisvandenbossche Apr 2, 2021
7cbdc5e

fix css for logo img on chrome


jorisvandenbossche Apr 2, 2021
6d70e0e

remove sphinx in-page content sidebar


jorisvandenbossche Apr 2, 2021
533d76c

fix sidebar / footer overlap


jorisvandenbossche Apr 2, 2021
486ee5e

more uniform colors


jorisvandenbossche Apr 6, 2021
aa8e496

center footer


jorisvandenbossche Apr 6, 2021
ed430a9

fine-tune sidebar height


jorisvandenbossche Apr 13, 2021
0910020

limit sidebar expanding for Pytho API section


jorisvandenbossche Apr 15, 2021
2ecc7a4

fix a few sphinx warnings


jorisvandenbossche Apr 15, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/conda_env_sphinx.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,4 @@ doxygen
ipython
# Pinned per ARROW-9693
sphinx=3.1.2
sphinx_rtd_theme
pydata-sphinx-theme

2 changes: 1 addition & 1 deletion
ci/docker/linux-apt-docs.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@ RUN pip install \
 breathe \
 ipython \
 sphinx \
sphinx_rtd_theme
pydata-sphinx-theme

COPY c_glib/Gemfile /arrow/c_glib/
RUN gem install --no-document bundler && \
Expand Down

2 changes: 1 addition & 1 deletion
docs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@ breathe
ipython
numpydoc
sphinx==2.4.4
sphinx_rtd_theme
pydata-sphinx-theme
Binary file addeddocs/source/_static/arrow.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/source/_static/favicon.ico

View file


Open in desktop


Binary file not shown.


53 changes: 53 additions & 0 deletions
docs/source/_static/theme_overrides.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,59 @@
 * under the License.
 */


/* Customizing with theme CSS variables */

:root {
 --pst-color-active-navigation: 215, 70, 51;
 --pst-color-link-hover: 215, 70, 51;
 --pst-color-headerlink: 215, 70, 51;
 /* Use normal text color (like h3, ..) instead of primary color */
 --pst-color-h1: var(--color-text-base);
 --pst-color-h2: var(--color-text-base);
 /* Use softer blue from bootstrap's default info color */
 --pst-color-info: 23, 162, 184;
 --pst-header-height: 0px;
}

code {
 color: rgb(215, 70, 51);
}

.footer {
 text-align: center;
}

/* Ensure the logo is properly displayed */

.navbar-brand {
 height: auto;
 width: auto;
}

a.navbar-brand img {
 height: auto;
 width: auto;
 max-height: 15vh;
 max-width: 100%;
}


/* Limit the max height of the sidebar navigation section. Because in our
custimized template, there is more content above the navigation, i.e.
larger logo: if we don't decrease the max-height, it will overlap with
the footer.
Details: min(15vh, 110px) for the logo size, 8rem for search box etc*/

@media (min-width:720px) {
 @supports (position:-webkit-sticky) or (position:sticky) {
 .bd-links {
 max-height: calc(100vh - min(15vh, 110px) - 8rem)
 }
 }
}


/* Fix table text wrapping in RTD theme,
 * see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
 */
Expand Down

19 changes: 19 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>

<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
 <div class="bd-toc-item active">
 {% if "python/api" in pagename or "python/generated" in pagename %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
 {% else %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
 {% endif %}
 </div>
</nav>

14 changes: 3 additions & 11 deletions
docs/source/_templates/layout.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{% extends "pydata_sphinx_theme/layout.html" %}

{%- block footer %}
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
 window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());

 gtag('config', 'UA-107500873-1');
</script>
{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}

14 changes: 9 additions & 5 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,14 +179,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
 'nosidebar': True
 "show_toc_level": 2,
 "google_analytics_id": "UA-107500873-1",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All@@ -204,13 +205,13 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = "_static/arrow.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
# html_favicon = None
html_favicon = "_static/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand DownExpand Up@@ -239,7 +240,10 @@

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
html_sidebars = {
# '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
 '**': ['docs-sidebar.html'],
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/array.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Arrays
======

.. sidebar:: Contents

 .. contents:: :local:

.. doxygenclass:: arrow::Array
 :project: arrow_cpp
 :members:
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

Datum class
-----------

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/dataset.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Dataset
=======

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/filesystem.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Filesystems
===========

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/io.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Input / output
==============

.. sidebar:: Contents

 .. contents:: :local:

Interfaces
==========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/ipc.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,10 +22,6 @@
Arrow IPC
=========

.. sidebar:: Contents

 .. contents:: :local:

IPC options
===========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

The generic Compute API
=======================

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/memory.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,6 @@ Memory Management
.. seealso::
 :doc:`Memory management API reference <api/memory>`

.. sidebar:: Contents

 .. contents:: :local:

Buffers
=======

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/parquet.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,6 @@ Reading and writing Parquet files
.. seealso::
 :ref:`Parquet reader and writer API reference <cpp-api-parquet>`.

.. sidebar:: Contents

 .. contents:: :local:

The `Parquet format <https://parquet.apache.org/documentation/latest/>`__
is a space-efficient columnar storage format for complex data. The Parquet
C++ implementation is part of the Apache Arrow project and benefits
Expand Down

2 changes: 1 addition & 1 deletion
docs/source/developers/cpp/windows.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ to the Unix-specific ``ccache``).
Newer versions of Visual Studio include Ninja. To see if your Visual Studio
includes Ninja, run the initialization command shown
:ref:`above<windows-system-setup>` (``vcvarsall.bat`` or ``VsDevCmd.bat``), then
run ``ninja --version``.
run ``ninja --version``.

If Ninja is not included in your version of Visual Studio, and you are using
conda, activate your conda environment and install Ninja and clcache:
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Guidelines.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Implementation Guidelines
=========================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/IPC.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

IPC
===

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Layout.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Physical Memory Layout
======================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Metadata.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Format Metadata
===============

Expand Down

3 changes: 0 additions & 3 deletions
docs/source/python/plasma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,6 @@
The Plasma In-Memory Object Store
=================================

.. contents:: Contents
 :depth: 3

.. note::

 As present, Plasma is only supported for use on Linux and macOS.
Expand Down

4 changes: 2 additions & 2 deletions
python/pyarrow/dataset.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,8 +517,8 @@ def dataset(source, schema=None, format=None, filesystem=None,

 Parameters
 ----------
 source : path, list of paths, dataset, list of datasets, (list of) batches
or tables, iterable of batches, RecordBatchReader, or URI
 source : path, list of paths, dataset, list of datasets, (list of) batches\
or tables, iterable of batches, RecordBatchReader, or URI
 Path pointing to a single file:
 Open a FileSystemDataset from a single file.
 Path pointing to a directory:
Expand Down

8 changes: 4 additions & 4 deletions
python/pyarrow/parquet.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -547,8 +547,8 @@ def _sanitize_table(table, new_schema, flavor):
 LogicalTypes.md#nested-types>`_, defaults to ``False``.
 For ``use_compliant_nested_type=True``, this will write into a list
 with 3-level structure where the middle level, named ``list``,
 is a repeated group with a single field named ``element``
 ::
 is a repeated group with a single field named ``element``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> element;
Expand All@@ -558,8 +558,8 @@ def _sanitize_table(table, new_schema, flavor):
 For ``use_compliant_nested_type=False``, this will also write into a list
 with 3-level structure, where the name of the single field of the middle
 level ``list`` is taken from the element name for nested columns in Arrow,
 which defaults to ``item``
 ::
 which defaults to ``item``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> item;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs#9876

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

 Closed

jorisvandenbossche
wants to merge
10
commits into

from

 Closed


ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs
#9876
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
a88f933

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx…


jorisvandenbossche Apr 2, 2021
894526f

replace sphinx_rtd_theme -> pydata-sphinx-theme


jorisvandenbossche Apr 2, 2021
7cbdc5e

fix css for logo img on chrome


jorisvandenbossche Apr 2, 2021
6d70e0e

remove sphinx in-page content sidebar


jorisvandenbossche Apr 2, 2021
533d76c

fix sidebar / footer overlap


jorisvandenbossche Apr 2, 2021
486ee5e

more uniform colors


jorisvandenbossche Apr 6, 2021
aa8e496

center footer


jorisvandenbossche Apr 6, 2021
ed430a9

fine-tune sidebar height


jorisvandenbossche Apr 13, 2021
0910020

limit sidebar expanding for Pytho API section


jorisvandenbossche Apr 15, 2021
2ecc7a4

fix a few sphinx warnings


jorisvandenbossche Apr 15, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/conda_env_sphinx.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,4 @@ doxygen
ipython
# Pinned per ARROW-9693
sphinx=3.1.2
sphinx_rtd_theme
pydata-sphinx-theme

2 changes: 1 addition & 1 deletion
ci/docker/linux-apt-docs.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@ RUN pip install \
 breathe \
 ipython \
 sphinx \
sphinx_rtd_theme
pydata-sphinx-theme

COPY c_glib/Gemfile /arrow/c_glib/
RUN gem install --no-document bundler && \
Expand Down

2 changes: 1 addition & 1 deletion
docs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@ breathe
ipython
numpydoc
sphinx==2.4.4
sphinx_rtd_theme
pydata-sphinx-theme
Binary file addeddocs/source/_static/arrow.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/source/_static/favicon.ico

View file


Open in desktop


Binary file not shown.


53 changes: 53 additions & 0 deletions
docs/source/_static/theme_overrides.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,59 @@
 * under the License.
 */


/* Customizing with theme CSS variables */

:root {
 --pst-color-active-navigation: 215, 70, 51;
 --pst-color-link-hover: 215, 70, 51;
 --pst-color-headerlink: 215, 70, 51;
 /* Use normal text color (like h3, ..) instead of primary color */
 --pst-color-h1: var(--color-text-base);
 --pst-color-h2: var(--color-text-base);
 /* Use softer blue from bootstrap's default info color */
 --pst-color-info: 23, 162, 184;
 --pst-header-height: 0px;
}

code {
 color: rgb(215, 70, 51);
}

.footer {
 text-align: center;
}

/* Ensure the logo is properly displayed */

.navbar-brand {
 height: auto;
 width: auto;
}

a.navbar-brand img {
 height: auto;
 width: auto;
 max-height: 15vh;
 max-width: 100%;
}


/* Limit the max height of the sidebar navigation section. Because in our
custimized template, there is more content above the navigation, i.e.
larger logo: if we don't decrease the max-height, it will overlap with
the footer.
Details: min(15vh, 110px) for the logo size, 8rem for search box etc*/

@media (min-width:720px) {
 @supports (position:-webkit-sticky) or (position:sticky) {
 .bd-links {
 max-height: calc(100vh - min(15vh, 110px) - 8rem)
 }
 }
}


/* Fix table text wrapping in RTD theme,
 * see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
 */
Expand Down

19 changes: 19 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>

<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
 <div class="bd-toc-item active">
 {% if "python/api" in pagename or "python/generated" in pagename %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
 {% else %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
 {% endif %}
 </div>
</nav>

14 changes: 3 additions & 11 deletions
docs/source/_templates/layout.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{% extends "pydata_sphinx_theme/layout.html" %}

{%- block footer %}
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
 window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());

 gtag('config', 'UA-107500873-1');
</script>
{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}

14 changes: 9 additions & 5 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,14 +179,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
 'nosidebar': True
 "show_toc_level": 2,
 "google_analytics_id": "UA-107500873-1",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All@@ -204,13 +205,13 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = "_static/arrow.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
# html_favicon = None
html_favicon = "_static/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand DownExpand Up@@ -239,7 +240,10 @@

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
html_sidebars = {
# '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
 '**': ['docs-sidebar.html'],
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/array.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Arrays
======

.. sidebar:: Contents

 .. contents:: :local:

.. doxygenclass:: arrow::Array
 :project: arrow_cpp
 :members:
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

Datum class
-----------

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/dataset.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Dataset
=======

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/filesystem.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Filesystems
===========

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/io.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Input / output
==============

.. sidebar:: Contents

 .. contents:: :local:

Interfaces
==========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/ipc.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,10 +22,6 @@
Arrow IPC
=========

.. sidebar:: Contents

 .. contents:: :local:

IPC options
===========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

The generic Compute API
=======================

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/memory.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,6 @@ Memory Management
.. seealso::
 :doc:`Memory management API reference <api/memory>`

.. sidebar:: Contents

 .. contents:: :local:

Buffers
=======

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/parquet.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,6 @@ Reading and writing Parquet files
.. seealso::
 :ref:`Parquet reader and writer API reference <cpp-api-parquet>`.

.. sidebar:: Contents

 .. contents:: :local:

The `Parquet format <https://parquet.apache.org/documentation/latest/>`__
is a space-efficient columnar storage format for complex data. The Parquet
C++ implementation is part of the Apache Arrow project and benefits
Expand Down

2 changes: 1 addition & 1 deletion
docs/source/developers/cpp/windows.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ to the Unix-specific ``ccache``).
Newer versions of Visual Studio include Ninja. To see if your Visual Studio
includes Ninja, run the initialization command shown
:ref:`above<windows-system-setup>` (``vcvarsall.bat`` or ``VsDevCmd.bat``), then
run ``ninja --version``.
run ``ninja --version``.

If Ninja is not included in your version of Visual Studio, and you are using
conda, activate your conda environment and install Ninja and clcache:
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Guidelines.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Implementation Guidelines
=========================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/IPC.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

IPC
===

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Layout.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Physical Memory Layout
======================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Metadata.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Format Metadata
===============

Expand Down

3 changes: 0 additions & 3 deletions
docs/source/python/plasma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,6 @@
The Plasma In-Memory Object Store
=================================

.. contents:: Contents
 :depth: 3

.. note::

 As present, Plasma is only supported for use on Linux and macOS.
Expand Down

4 changes: 2 additions & 2 deletions
python/pyarrow/dataset.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,8 +517,8 @@ def dataset(source, schema=None, format=None, filesystem=None,

 Parameters
 ----------
 source : path, list of paths, dataset, list of datasets, (list of) batches
or tables, iterable of batches, RecordBatchReader, or URI
 source : path, list of paths, dataset, list of datasets, (list of) batches\
or tables, iterable of batches, RecordBatchReader, or URI
 Path pointing to a single file:
 Open a FileSystemDataset from a single file.
 Path pointing to a directory:
Expand Down

8 changes: 4 additions & 4 deletions
python/pyarrow/parquet.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -547,8 +547,8 @@ def _sanitize_table(table, new_schema, flavor):
 LogicalTypes.md#nested-types>`_, defaults to ``False``.
 For ``use_compliant_nested_type=True``, this will write into a list
 with 3-level structure where the middle level, named ``list``,
 is a repeated group with a single field named ``element``
 ::
 is a repeated group with a single field named ``element``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> element;
Expand All@@ -558,8 +558,8 @@ def _sanitize_table(table, new_schema, flavor):
 For ``use_compliant_nested_type=False``, this will also write into a list
 with 3-level structure, where the name of the single field of the middle
 level ``list`` is taken from the element name for nested columns in Arrow,
 which defaults to ``item``
 ::
 which defaults to ``item``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> item;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs#9876

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

 Closed

jorisvandenbossche
wants to merge
10
commits into

from

 Closed


ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs
#9876
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
a88f933

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx…


jorisvandenbossche Apr 2, 2021
894526f

replace sphinx_rtd_theme -> pydata-sphinx-theme


jorisvandenbossche Apr 2, 2021
7cbdc5e

fix css for logo img on chrome


jorisvandenbossche Apr 2, 2021
6d70e0e

remove sphinx in-page content sidebar


jorisvandenbossche Apr 2, 2021
533d76c

fix sidebar / footer overlap


jorisvandenbossche Apr 2, 2021
486ee5e

more uniform colors


jorisvandenbossche Apr 6, 2021
aa8e496

center footer


jorisvandenbossche Apr 6, 2021
ed430a9

fine-tune sidebar height


jorisvandenbossche Apr 13, 2021
0910020

limit sidebar expanding for Pytho API section


jorisvandenbossche Apr 15, 2021
2ecc7a4

fix a few sphinx warnings


jorisvandenbossche Apr 15, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/conda_env_sphinx.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,4 @@ doxygen
ipython
# Pinned per ARROW-9693
sphinx=3.1.2
sphinx_rtd_theme
pydata-sphinx-theme

2 changes: 1 addition & 1 deletion
ci/docker/linux-apt-docs.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@ RUN pip install \
 breathe \
 ipython \
 sphinx \
sphinx_rtd_theme
pydata-sphinx-theme

COPY c_glib/Gemfile /arrow/c_glib/
RUN gem install --no-document bundler && \
Expand Down

2 changes: 1 addition & 1 deletion
docs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@ breathe
ipython
numpydoc
sphinx==2.4.4
sphinx_rtd_theme
pydata-sphinx-theme
Binary file addeddocs/source/_static/arrow.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/source/_static/favicon.ico

View file


Open in desktop


Binary file not shown.


53 changes: 53 additions & 0 deletions
docs/source/_static/theme_overrides.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,59 @@
 * under the License.
 */


/* Customizing with theme CSS variables */

:root {
 --pst-color-active-navigation: 215, 70, 51;
 --pst-color-link-hover: 215, 70, 51;
 --pst-color-headerlink: 215, 70, 51;
 /* Use normal text color (like h3, ..) instead of primary color */
 --pst-color-h1: var(--color-text-base);
 --pst-color-h2: var(--color-text-base);
 /* Use softer blue from bootstrap's default info color */
 --pst-color-info: 23, 162, 184;
 --pst-header-height: 0px;
}

code {
 color: rgb(215, 70, 51);
}

.footer {
 text-align: center;
}

/* Ensure the logo is properly displayed */

.navbar-brand {
 height: auto;
 width: auto;
}

a.navbar-brand img {
 height: auto;
 width: auto;
 max-height: 15vh;
 max-width: 100%;
}


/* Limit the max height of the sidebar navigation section. Because in our
custimized template, there is more content above the navigation, i.e.
larger logo: if we don't decrease the max-height, it will overlap with
the footer.
Details: min(15vh, 110px) for the logo size, 8rem for search box etc*/

@media (min-width:720px) {
 @supports (position:-webkit-sticky) or (position:sticky) {
 .bd-links {
 max-height: calc(100vh - min(15vh, 110px) - 8rem)
 }
 }
}


/* Fix table text wrapping in RTD theme,
 * see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
 */
Expand Down

19 changes: 19 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>

<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
 <div class="bd-toc-item active">
 {% if "python/api" in pagename or "python/generated" in pagename %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
 {% else %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
 {% endif %}
 </div>
</nav>

14 changes: 3 additions & 11 deletions
docs/source/_templates/layout.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{% extends "pydata_sphinx_theme/layout.html" %}

{%- block footer %}
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
 window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());

 gtag('config', 'UA-107500873-1');
</script>
{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}

14 changes: 9 additions & 5 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,14 +179,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
 'nosidebar': True
 "show_toc_level": 2,
 "google_analytics_id": "UA-107500873-1",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All@@ -204,13 +205,13 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = "_static/arrow.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
# html_favicon = None
html_favicon = "_static/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand DownExpand Up@@ -239,7 +240,10 @@

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
html_sidebars = {
# '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
 '**': ['docs-sidebar.html'],
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/array.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Arrays
======

.. sidebar:: Contents

 .. contents:: :local:

.. doxygenclass:: arrow::Array
 :project: arrow_cpp
 :members:
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

Datum class
-----------

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/dataset.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Dataset
=======

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/filesystem.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Filesystems
===========

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/io.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Input / output
==============

.. sidebar:: Contents

 .. contents:: :local:

Interfaces
==========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/ipc.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,10 +22,6 @@
Arrow IPC
=========

.. sidebar:: Contents

 .. contents:: :local:

IPC options
===========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

The generic Compute API
=======================

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/memory.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,6 @@ Memory Management
.. seealso::
 :doc:`Memory management API reference <api/memory>`

.. sidebar:: Contents

 .. contents:: :local:

Buffers
=======

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/parquet.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,6 @@ Reading and writing Parquet files
.. seealso::
 :ref:`Parquet reader and writer API reference <cpp-api-parquet>`.

.. sidebar:: Contents

 .. contents:: :local:

The `Parquet format <https://parquet.apache.org/documentation/latest/>`__
is a space-efficient columnar storage format for complex data. The Parquet
C++ implementation is part of the Apache Arrow project and benefits
Expand Down

2 changes: 1 addition & 1 deletion
docs/source/developers/cpp/windows.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ to the Unix-specific ``ccache``).
Newer versions of Visual Studio include Ninja. To see if your Visual Studio
includes Ninja, run the initialization command shown
:ref:`above<windows-system-setup>` (``vcvarsall.bat`` or ``VsDevCmd.bat``), then
run ``ninja --version``.
run ``ninja --version``.

If Ninja is not included in your version of Visual Studio, and you are using
conda, activate your conda environment and install Ninja and clcache:
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Guidelines.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Implementation Guidelines
=========================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/IPC.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

IPC
===

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Layout.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Physical Memory Layout
======================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Metadata.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Format Metadata
===============

Expand Down

3 changes: 0 additions & 3 deletions
docs/source/python/plasma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,6 @@
The Plasma In-Memory Object Store
=================================

.. contents:: Contents
 :depth: 3

.. note::

 As present, Plasma is only supported for use on Linux and macOS.
Expand Down

4 changes: 2 additions & 2 deletions
python/pyarrow/dataset.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,8 +517,8 @@ def dataset(source, schema=None, format=None, filesystem=None,

 Parameters
 ----------
 source : path, list of paths, dataset, list of datasets, (list of) batches
or tables, iterable of batches, RecordBatchReader, or URI
 source : path, list of paths, dataset, list of datasets, (list of) batches\
or tables, iterable of batches, RecordBatchReader, or URI
 Path pointing to a single file:
 Open a FileSystemDataset from a single file.
 Path pointing to a directory:
Expand Down

8 changes: 4 additions & 4 deletions
python/pyarrow/parquet.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -547,8 +547,8 @@ def _sanitize_table(table, new_schema, flavor):
 LogicalTypes.md#nested-types>`_, defaults to ``False``.
 For ``use_compliant_nested_type=True``, this will write into a list
 with 3-level structure where the middle level, named ``list``,
 is a repeated group with a single field named ``element``
 ::
 is a repeated group with a single field named ``element``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> element;
Expand All@@ -558,8 +558,8 @@ def _sanitize_table(table, new_schema, flavor):
 For ``use_compliant_nested_type=False``, this will also write into a list
 with 3-level structure, where the name of the single field of the middle
 level ``list`` is taken from the element name for nested columns in Arrow,
 which defaults to ``item``
 ::
 which defaults to ``item``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> item;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs#9876

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

 Closed

jorisvandenbossche
wants to merge
10
commits into

from

 Closed


ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs
#9876
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
a88f933

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx…


jorisvandenbossche Apr 2, 2021
894526f

replace sphinx_rtd_theme -> pydata-sphinx-theme


jorisvandenbossche Apr 2, 2021
7cbdc5e

fix css for logo img on chrome


jorisvandenbossche Apr 2, 2021
6d70e0e

remove sphinx in-page content sidebar


jorisvandenbossche Apr 2, 2021
533d76c

fix sidebar / footer overlap


jorisvandenbossche Apr 2, 2021
486ee5e

more uniform colors


jorisvandenbossche Apr 6, 2021
aa8e496

center footer


jorisvandenbossche Apr 6, 2021
ed430a9

fine-tune sidebar height


jorisvandenbossche Apr 13, 2021
0910020

limit sidebar expanding for Pytho API section


jorisvandenbossche Apr 15, 2021
2ecc7a4

fix a few sphinx warnings


jorisvandenbossche Apr 15, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/conda_env_sphinx.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,4 @@ doxygen
ipython
# Pinned per ARROW-9693
sphinx=3.1.2
sphinx_rtd_theme
pydata-sphinx-theme

2 changes: 1 addition & 1 deletion
ci/docker/linux-apt-docs.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@ RUN pip install \
 breathe \
 ipython \
 sphinx \
sphinx_rtd_theme
pydata-sphinx-theme

COPY c_glib/Gemfile /arrow/c_glib/
RUN gem install --no-document bundler && \
Expand Down

2 changes: 1 addition & 1 deletion
docs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@ breathe
ipython
numpydoc
sphinx==2.4.4
sphinx_rtd_theme
pydata-sphinx-theme
Binary file addeddocs/source/_static/arrow.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/source/_static/favicon.ico

View file


Open in desktop


Binary file not shown.


53 changes: 53 additions & 0 deletions
docs/source/_static/theme_overrides.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,59 @@
 * under the License.
 */


/* Customizing with theme CSS variables */

:root {
 --pst-color-active-navigation: 215, 70, 51;
 --pst-color-link-hover: 215, 70, 51;
 --pst-color-headerlink: 215, 70, 51;
 /* Use normal text color (like h3, ..) instead of primary color */
 --pst-color-h1: var(--color-text-base);
 --pst-color-h2: var(--color-text-base);
 /* Use softer blue from bootstrap's default info color */
 --pst-color-info: 23, 162, 184;
 --pst-header-height: 0px;
}

code {
 color: rgb(215, 70, 51);
}

.footer {
 text-align: center;
}

/* Ensure the logo is properly displayed */

.navbar-brand {
 height: auto;
 width: auto;
}

a.navbar-brand img {
 height: auto;
 width: auto;
 max-height: 15vh;
 max-width: 100%;
}


/* Limit the max height of the sidebar navigation section. Because in our
custimized template, there is more content above the navigation, i.e.
larger logo: if we don't decrease the max-height, it will overlap with
the footer.
Details: min(15vh, 110px) for the logo size, 8rem for search box etc*/

@media (min-width:720px) {
 @supports (position:-webkit-sticky) or (position:sticky) {
 .bd-links {
 max-height: calc(100vh - min(15vh, 110px) - 8rem)
 }
 }
}


/* Fix table text wrapping in RTD theme,
 * see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
 */
Expand Down

19 changes: 19 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>

<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
 <div class="bd-toc-item active">
 {% if "python/api" in pagename or "python/generated" in pagename %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
 {% else %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
 {% endif %}
 </div>
</nav>

14 changes: 3 additions & 11 deletions
docs/source/_templates/layout.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{% extends "pydata_sphinx_theme/layout.html" %}

{%- block footer %}
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
 window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());

 gtag('config', 'UA-107500873-1');
</script>
{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}

14 changes: 9 additions & 5 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,14 +179,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
 'nosidebar': True
 "show_toc_level": 2,
 "google_analytics_id": "UA-107500873-1",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All@@ -204,13 +205,13 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = "_static/arrow.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
# html_favicon = None
html_favicon = "_static/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand DownExpand Up@@ -239,7 +240,10 @@

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
html_sidebars = {
# '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
 '**': ['docs-sidebar.html'],
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/array.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Arrays
======

.. sidebar:: Contents

 .. contents:: :local:

.. doxygenclass:: arrow::Array
 :project: arrow_cpp
 :members:
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

Datum class
-----------

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/dataset.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Dataset
=======

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/filesystem.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Filesystems
===========

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/io.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Input / output
==============

.. sidebar:: Contents

 .. contents:: :local:

Interfaces
==========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/ipc.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,10 +22,6 @@
Arrow IPC
=========

.. sidebar:: Contents

 .. contents:: :local:

IPC options
===========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

The generic Compute API
=======================

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/memory.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,6 @@ Memory Management
.. seealso::
 :doc:`Memory management API reference <api/memory>`

.. sidebar:: Contents

 .. contents:: :local:

Buffers
=======

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/parquet.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,6 @@ Reading and writing Parquet files
.. seealso::
 :ref:`Parquet reader and writer API reference <cpp-api-parquet>`.

.. sidebar:: Contents

 .. contents:: :local:

The `Parquet format <https://parquet.apache.org/documentation/latest/>`__
is a space-efficient columnar storage format for complex data. The Parquet
C++ implementation is part of the Apache Arrow project and benefits
Expand Down

2 changes: 1 addition & 1 deletion
docs/source/developers/cpp/windows.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ to the Unix-specific ``ccache``).
Newer versions of Visual Studio include Ninja. To see if your Visual Studio
includes Ninja, run the initialization command shown
:ref:`above<windows-system-setup>` (``vcvarsall.bat`` or ``VsDevCmd.bat``), then
run ``ninja --version``.
run ``ninja --version``.

If Ninja is not included in your version of Visual Studio, and you are using
conda, activate your conda environment and install Ninja and clcache:
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Guidelines.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Implementation Guidelines
=========================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/IPC.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

IPC
===

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Layout.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Physical Memory Layout
======================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Metadata.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Format Metadata
===============

Expand Down

3 changes: 0 additions & 3 deletions
docs/source/python/plasma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,6 @@
The Plasma In-Memory Object Store
=================================

.. contents:: Contents
 :depth: 3

.. note::

 As present, Plasma is only supported for use on Linux and macOS.
Expand Down

4 changes: 2 additions & 2 deletions
python/pyarrow/dataset.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,8 +517,8 @@ def dataset(source, schema=None, format=None, filesystem=None,

 Parameters
 ----------
 source : path, list of paths, dataset, list of datasets, (list of) batches
or tables, iterable of batches, RecordBatchReader, or URI
 source : path, list of paths, dataset, list of datasets, (list of) batches\
or tables, iterable of batches, RecordBatchReader, or URI
 Path pointing to a single file:
 Open a FileSystemDataset from a single file.
 Path pointing to a directory:
Expand Down

8 changes: 4 additions & 4 deletions
python/pyarrow/parquet.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -547,8 +547,8 @@ def _sanitize_table(table, new_schema, flavor):
 LogicalTypes.md#nested-types>`_, defaults to ``False``.
 For ``use_compliant_nested_type=True``, this will write into a list
 with 3-level structure where the middle level, named ``list``,
 is a repeated group with a single field named ``element``
 ::
 is a repeated group with a single field named ``element``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> element;
Expand All@@ -558,8 +558,8 @@ def _sanitize_table(table, new_schema, flavor):
 For ``use_compliant_nested_type=False``, this will also write into a list
 with 3-level structure, where the name of the single field of the middle
 level ``list`` is taken from the element name for nested columns in Arrow,
 which defaults to ``item``
 ::
 which defaults to ``item``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> item;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs#9876

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

 Closed

jorisvandenbossche
wants to merge
10
commits into

from

 Closed


ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs
#9876
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
a88f933

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx…


jorisvandenbossche Apr 2, 2021
894526f

replace sphinx_rtd_theme -> pydata-sphinx-theme


jorisvandenbossche Apr 2, 2021
7cbdc5e

fix css for logo img on chrome


jorisvandenbossche Apr 2, 2021
6d70e0e

remove sphinx in-page content sidebar


jorisvandenbossche Apr 2, 2021
533d76c

fix sidebar / footer overlap


jorisvandenbossche Apr 2, 2021
486ee5e

more uniform colors


jorisvandenbossche Apr 6, 2021
aa8e496

center footer


jorisvandenbossche Apr 6, 2021
ed430a9

fine-tune sidebar height


jorisvandenbossche Apr 13, 2021
0910020

limit sidebar expanding for Pytho API section


jorisvandenbossche Apr 15, 2021
2ecc7a4

fix a few sphinx warnings


jorisvandenbossche Apr 15, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/conda_env_sphinx.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,4 @@ doxygen
ipython
# Pinned per ARROW-9693
sphinx=3.1.2
sphinx_rtd_theme
pydata-sphinx-theme

2 changes: 1 addition & 1 deletion
ci/docker/linux-apt-docs.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@ RUN pip install \
 breathe \
 ipython \
 sphinx \
sphinx_rtd_theme
pydata-sphinx-theme

COPY c_glib/Gemfile /arrow/c_glib/
RUN gem install --no-document bundler && \
Expand Down

2 changes: 1 addition & 1 deletion
docs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@ breathe
ipython
numpydoc
sphinx==2.4.4
sphinx_rtd_theme
pydata-sphinx-theme
Binary file addeddocs/source/_static/arrow.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/source/_static/favicon.ico

View file


Open in desktop


Binary file not shown.


53 changes: 53 additions & 0 deletions
docs/source/_static/theme_overrides.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,59 @@
 * under the License.
 */


/* Customizing with theme CSS variables */

:root {
 --pst-color-active-navigation: 215, 70, 51;
 --pst-color-link-hover: 215, 70, 51;
 --pst-color-headerlink: 215, 70, 51;
 /* Use normal text color (like h3, ..) instead of primary color */
 --pst-color-h1: var(--color-text-base);
 --pst-color-h2: var(--color-text-base);
 /* Use softer blue from bootstrap's default info color */
 --pst-color-info: 23, 162, 184;
 --pst-header-height: 0px;
}

code {
 color: rgb(215, 70, 51);
}

.footer {
 text-align: center;
}

/* Ensure the logo is properly displayed */

.navbar-brand {
 height: auto;
 width: auto;
}

a.navbar-brand img {
 height: auto;
 width: auto;
 max-height: 15vh;
 max-width: 100%;
}


/* Limit the max height of the sidebar navigation section. Because in our
custimized template, there is more content above the navigation, i.e.
larger logo: if we don't decrease the max-height, it will overlap with
the footer.
Details: min(15vh, 110px) for the logo size, 8rem for search box etc*/

@media (min-width:720px) {
 @supports (position:-webkit-sticky) or (position:sticky) {
 .bd-links {
 max-height: calc(100vh - min(15vh, 110px) - 8rem)
 }
 }
}


/* Fix table text wrapping in RTD theme,
 * see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
 */
Expand Down

19 changes: 19 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>

<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
 <div class="bd-toc-item active">
 {% if "python/api" in pagename or "python/generated" in pagename %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
 {% else %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
 {% endif %}
 </div>
</nav>

14 changes: 3 additions & 11 deletions
docs/source/_templates/layout.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{% extends "pydata_sphinx_theme/layout.html" %}

{%- block footer %}
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
 window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());

 gtag('config', 'UA-107500873-1');
</script>
{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}

14 changes: 9 additions & 5 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,14 +179,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
 'nosidebar': True
 "show_toc_level": 2,
 "google_analytics_id": "UA-107500873-1",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All@@ -204,13 +205,13 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = "_static/arrow.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
# html_favicon = None
html_favicon = "_static/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand DownExpand Up@@ -239,7 +240,10 @@

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
html_sidebars = {
# '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
 '**': ['docs-sidebar.html'],
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/array.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Arrays
======

.. sidebar:: Contents

 .. contents:: :local:

.. doxygenclass:: arrow::Array
 :project: arrow_cpp
 :members:
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

Datum class
-----------

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/dataset.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Dataset
=======

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/filesystem.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Filesystems
===========

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/io.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Input / output
==============

.. sidebar:: Contents

 .. contents:: :local:

Interfaces
==========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/ipc.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,10 +22,6 @@
Arrow IPC
=========

.. sidebar:: Contents

 .. contents:: :local:

IPC options
===========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

The generic Compute API
=======================

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/memory.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,6 @@ Memory Management
.. seealso::
 :doc:`Memory management API reference <api/memory>`

.. sidebar:: Contents

 .. contents:: :local:

Buffers
=======

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/parquet.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,6 @@ Reading and writing Parquet files
.. seealso::
 :ref:`Parquet reader and writer API reference <cpp-api-parquet>`.

.. sidebar:: Contents

 .. contents:: :local:

The `Parquet format <https://parquet.apache.org/documentation/latest/>`__
is a space-efficient columnar storage format for complex data. The Parquet
C++ implementation is part of the Apache Arrow project and benefits
Expand Down

2 changes: 1 addition & 1 deletion
docs/source/developers/cpp/windows.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ to the Unix-specific ``ccache``).
Newer versions of Visual Studio include Ninja. To see if your Visual Studio
includes Ninja, run the initialization command shown
:ref:`above<windows-system-setup>` (``vcvarsall.bat`` or ``VsDevCmd.bat``), then
run ``ninja --version``.
run ``ninja --version``.

If Ninja is not included in your version of Visual Studio, and you are using
conda, activate your conda environment and install Ninja and clcache:
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Guidelines.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Implementation Guidelines
=========================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/IPC.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

IPC
===

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Layout.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Physical Memory Layout
======================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Metadata.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Format Metadata
===============

Expand Down

3 changes: 0 additions & 3 deletions
docs/source/python/plasma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,6 @@
The Plasma In-Memory Object Store
=================================

.. contents:: Contents
 :depth: 3

.. note::

 As present, Plasma is only supported for use on Linux and macOS.
Expand Down

4 changes: 2 additions & 2 deletions
python/pyarrow/dataset.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,8 +517,8 @@ def dataset(source, schema=None, format=None, filesystem=None,

 Parameters
 ----------
 source : path, list of paths, dataset, list of datasets, (list of) batches
or tables, iterable of batches, RecordBatchReader, or URI
 source : path, list of paths, dataset, list of datasets, (list of) batches\
or tables, iterable of batches, RecordBatchReader, or URI
 Path pointing to a single file:
 Open a FileSystemDataset from a single file.
 Path pointing to a directory:
Expand Down

8 changes: 4 additions & 4 deletions
python/pyarrow/parquet.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -547,8 +547,8 @@ def _sanitize_table(table, new_schema, flavor):
 LogicalTypes.md#nested-types>`_, defaults to ``False``.
 For ``use_compliant_nested_type=True``, this will write into a list
 with 3-level structure where the middle level, named ``list``,
 is a repeated group with a single field named ``element``
 ::
 is a repeated group with a single field named ``element``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> element;
Expand All@@ -558,8 +558,8 @@ def _sanitize_table(table, new_schema, flavor):
 For ``use_compliant_nested_type=False``, this will also write into a list
 with 3-level structure, where the name of the single field of the middle
 level ``list`` is taken from the element name for nested columns in Arrow,
 which defaults to ``item``
 ::
 which defaults to ``item``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> item;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs#9876

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

 Closed

jorisvandenbossche
wants to merge
10
commits into

from

 Closed


ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs
#9876
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
a88f933

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx…


jorisvandenbossche Apr 2, 2021
894526f

replace sphinx_rtd_theme -> pydata-sphinx-theme


jorisvandenbossche Apr 2, 2021
7cbdc5e

fix css for logo img on chrome


jorisvandenbossche Apr 2, 2021
6d70e0e

remove sphinx in-page content sidebar


jorisvandenbossche Apr 2, 2021
533d76c

fix sidebar / footer overlap


jorisvandenbossche Apr 2, 2021
486ee5e

more uniform colors


jorisvandenbossche Apr 6, 2021
aa8e496

center footer


jorisvandenbossche Apr 6, 2021
ed430a9

fine-tune sidebar height


jorisvandenbossche Apr 13, 2021
0910020

limit sidebar expanding for Pytho API section


jorisvandenbossche Apr 15, 2021
2ecc7a4

fix a few sphinx warnings


jorisvandenbossche Apr 15, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
ci/conda_env_sphinx.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,4 +21,4 @@ doxygen
ipython
# Pinned per ARROW-9693
sphinx=3.1.2
sphinx_rtd_theme
pydata-sphinx-theme

2 changes: 1 addition & 1 deletion
ci/docker/linux-apt-docs.dockerfile

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@ RUN pip install \
 breathe \
 ipython \
 sphinx \
sphinx_rtd_theme
pydata-sphinx-theme

COPY c_glib/Gemfile /arrow/c_glib/
RUN gem install --no-document bundler && \
Expand Down

2 changes: 1 addition & 1 deletion
docs/requirements.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@ breathe
ipython
numpydoc
sphinx==2.4.4
sphinx_rtd_theme
pydata-sphinx-theme
Binary file addeddocs/source/_static/arrow.png

View file


Open in desktop

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/source/_static/favicon.ico

View file


Open in desktop


Binary file not shown.


53 changes: 53 additions & 0 deletions
docs/source/_static/theme_overrides.css

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,59 @@
 * under the License.
 */


/* Customizing with theme CSS variables */

:root {
 --pst-color-active-navigation: 215, 70, 51;
 --pst-color-link-hover: 215, 70, 51;
 --pst-color-headerlink: 215, 70, 51;
 /* Use normal text color (like h3, ..) instead of primary color */
 --pst-color-h1: var(--color-text-base);
 --pst-color-h2: var(--color-text-base);
 /* Use softer blue from bootstrap's default info color */
 --pst-color-info: 23, 162, 184;
 --pst-header-height: 0px;
}

code {
 color: rgb(215, 70, 51);
}

.footer {
 text-align: center;
}

/* Ensure the logo is properly displayed */

.navbar-brand {
 height: auto;
 width: auto;
}

a.navbar-brand img {
 height: auto;
 width: auto;
 max-height: 15vh;
 max-width: 100%;
}


/* Limit the max height of the sidebar navigation section. Because in our
custimized template, there is more content above the navigation, i.e.
larger logo: if we don't decrease the max-height, it will overlap with
the footer.
Details: min(15vh, 110px) for the logo size, 8rem for search box etc*/

@media (min-width:720px) {
 @supports (position:-webkit-sticky) or (position:sticky) {
 .bd-links {
 max-height: calc(100vh - min(15vh, 110px) - 8rem)
 }
 }
}


/* Fix table text wrapping in RTD theme,
 * see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
 */
Expand Down

19 changes: 19 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>

<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
 <div class="bd-toc-item active">
 {% if "python/api" in pagename or "python/generated" in pagename %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
 {% else %}
 {{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
 {% endif %}
 </div>
</nav>

14 changes: 3 additions & 11 deletions
docs/source/_templates/layout.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{% extends "pydata_sphinx_theme/layout.html" %}

{%- block footer %}
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1"></script>
<script>
 window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());

 gtag('config', 'UA-107500873-1');
</script>
{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}

14 changes: 9 additions & 5 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,14 +179,15 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'pydata_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
 'nosidebar': True
 "show_toc_level": 2,
 "google_analytics_id": "UA-107500873-1",
}

# Add any paths that contain custom themes here, relative to this directory.
Expand All@@ -204,13 +205,13 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = "_static/arrow.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or
# 32x32 pixels large.
#
# html_favicon = None
html_favicon = "_static/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand DownExpand Up@@ -239,7 +240,10 @@

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
html_sidebars = {
# '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
 '**': ['docs-sidebar.html'],
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/array.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Arrays
======

.. sidebar:: Contents

 .. contents:: :local:

.. doxygenclass:: arrow::Array
 :project: arrow_cpp
 :members:
Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,10 +18,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

Datum class
-----------

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/dataset.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Dataset
=======

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/filesystem.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Filesystems
===========

.. sidebar:: Contents

 .. contents:: :local:

Interface
=========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/io.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,10 +19,6 @@
Input / output
==============

.. sidebar:: Contents

 .. contents:: :local:

Interfaces
==========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/api/ipc.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,10 +22,6 @@
Arrow IPC
=========

.. sidebar:: Contents

 .. contents:: :local:

IPC options
===========

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/compute.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,10 +23,6 @@
Compute Functions
=================

.. sidebar:: Contents

 .. contents:: :local:

The generic Compute API
=======================

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/memory.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,6 @@ Memory Management
.. seealso::
 :doc:`Memory management API reference <api/memory>`

.. sidebar:: Contents

 .. contents:: :local:

Buffers
=======

Expand Down

4 changes: 0 additions & 4 deletions
docs/source/cpp/parquet.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,6 @@ Reading and writing Parquet files
.. seealso::
 :ref:`Parquet reader and writer API reference <cpp-api-parquet>`.

.. sidebar:: Contents

 .. contents:: :local:

The `Parquet format <https://parquet.apache.org/documentation/latest/>`__
is a space-efficient columnar storage format for complex data. The Parquet
C++ implementation is part of the Apache Arrow project and benefits
Expand Down

2 changes: 1 addition & 1 deletion
docs/source/developers/cpp/windows.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,7 +194,7 @@ to the Unix-specific ``ccache``).
Newer versions of Visual Studio include Ninja. To see if your Visual Studio
includes Ninja, run the initialization command shown
:ref:`above<windows-system-setup>` (``vcvarsall.bat`` or ``VsDevCmd.bat``), then
run ``ninja --version``.
run ``ninja --version``.

If Ninja is not included in your version of Visual Studio, and you are using
conda, activate your conda environment and install Ninja and clcache:
Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Guidelines.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Implementation Guidelines
=========================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/IPC.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

IPC
===

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Layout.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Physical Memory Layout
======================

Expand Down

2 changes: 2 additions & 0 deletions
docs/source/format/Metadata.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

:orphan:

Format Metadata
===============

Expand Down

3 changes: 0 additions & 3 deletions
docs/source/python/plasma.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,9 +21,6 @@
The Plasma In-Memory Object Store
=================================

.. contents:: Contents
 :depth: 3

.. note::

 As present, Plasma is only supported for use on Linux and macOS.
Expand Down

4 changes: 2 additions & 2 deletions
python/pyarrow/dataset.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,8 +517,8 @@ def dataset(source, schema=None, format=None, filesystem=None,

 Parameters
 ----------
 source : path, list of paths, dataset, list of datasets, (list of) batches
or tables, iterable of batches, RecordBatchReader, or URI
 source : path, list of paths, dataset, list of datasets, (list of) batches\
or tables, iterable of batches, RecordBatchReader, or URI
 Path pointing to a single file:
 Open a FileSystemDataset from a single file.
 Path pointing to a directory:
Expand Down

8 changes: 4 additions & 4 deletions
python/pyarrow/parquet.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -547,8 +547,8 @@ def _sanitize_table(table, new_schema, flavor):
 LogicalTypes.md#nested-types>`_, defaults to ``False``.
 For ``use_compliant_nested_type=True``, this will write into a list
 with 3-level structure where the middle level, named ``list``,
 is a repeated group with a single field named ``element``
 ::
 is a repeated group with a single field named ``element``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> element;
Expand All@@ -558,8 +558,8 @@ def _sanitize_table(table, new_schema, flavor):
 For ``use_compliant_nested_type=False``, this will also write into a list
 with 3-level structure, where the name of the single field of the middle
 level ``list`` is taken from the element name for nested columns in Arrow,
 which defaults to ``item``
 ::
 which defaults to ``item``::

 <list-repetition> group <name> (LIST) {
 repeated group list {
 <element-repetition> <element-type> item;
Expand Down