Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

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

DOC: captions + update for latest pydata-sphinx-theme #175

Merged
merged 2 commits into from Aug 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 5 additions & 9 deletions docs/_static/css/custom.css
@@ -1,21 +1,17 @@
/* Override some aspects of the pydata-sphinx-theme */

:root {
--color-active-navigation: 0, 91, 129;
--pst-color-active-navigation: 0, 91, 129;
/* Use normal text color (like h3, ..) instead of primary color */
--color-h1: var(--color-text-base);
--color-h2: var(--color-text-base);
}


body {
padding-top: 0px;
--pst-color-h1: var(--pst-color-text-base);
--pst-color-h2: var(--pst-color-text-base);
--pst-header-height: 0px;
}

@media (min-width: 768px) {
@supports (position: -webkit-sticky) or (position: sticky) {
.bd-sidebar {
top: 40px;
padding-top: 3rem;
}
}
}
Expand Down
23 changes: 6 additions & 17 deletions docs/_templates/docs-sidebar.html
Expand Up @@ -14,21 +14,10 @@
<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">
{% set nav = get_nav_object(maxdepth=3, collapse=True) %}

</form>


<ul class="nav bd-sidenav">
{% for nav_item in nav %}
<li class="nav-item {% if nav_item.active%}active{% endif %}">
<a class="nav-link" href="{{ nav_item.url }}">{{ nav_item.title }}</a>
</li>
{% endfor %}
</ul>

</nav>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
{{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
</div>
</nav>
4 changes: 0 additions & 4 deletions docs/_templates/layout.html
@@ -1,9 +1,5 @@
{% extends "pydata_sphinx_theme/layout.html" %}

<!-- Docs TOC is "d-none d-xl-block col-xl-2" -->

{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}


3 changes: 1 addition & 2 deletions docs/environment.yml
Expand Up @@ -18,5 +18,4 @@ dependencies:
- nbsphinx
- pandoc
- ipython
- pip:
- git+https://github.com/pandas-dev/pydata-sphinx-theme.git@master
- pydata-sphinx-theme
6 changes: 6 additions & 0 deletions docs/index.rst
Expand Up @@ -11,12 +11,18 @@ Contents

.. toctree::
:maxdepth: 2
:caption: User Guide

intro_guide
warping_guide
working_with_local_files
providers_deepdive
friends_gee

.. toctree::
:maxdepth: 2
:caption: Reference Guide

reference


Expand Down