Skip to content

feat: Hide right sidebar in documentation #19

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

Merged
CyrilJl merged 1 commit into from
Aug 28, 2025
Merged

feat: Hide right sidebar in documentation #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions docs/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{%- extends "!layout.html" %}

{{ super() }}

{%- block main %}
{%- if meta is defined and meta is not none and 'notoc' in meta %}
<main class="relative py-6">
{%- else %}
<main class="relative py-6 lg:gap-10 lg:py-8 xl:grid xl:grid-cols-[1fr_300px]">
{%- endif %}
{%- block body %}{%- endblock %}
</main>
{%- endblock main %}
9 changes: 9 additions & 0 deletions docs/_templates/page.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{%- extends "!page.html" -%}

{{ super() }}

{%- block on_page_toc %}
{%- if (meta is not defined or meta is none or "notoc" not in meta) and display_toc %}
{%- include "toc.html" %}
{%- endif %}
{% endblock %}
2 changes: 1 addition & 1 deletion docs/how_to_use.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Creating a static plot
ds = xr.tutorial.open_dataset("era5-2mt-2019-03-uk.grib")
plot_da(da=ds['t2m'].isel(time=0))

.. image:: /_static/plot_da.png
.. image:: ../_static/plot_da.png
:alt: Sample output of plot_da function
:align: center
:width: 75%
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:notoc: true

.. _index:

Welcome to mapflow's documentation!
Expand Down
Loading