Skip to content

Add a pretty JupyterLite button to docs #361

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
martinRenou merged 1 commit into from
Jan 18, 2025
Merged

Add a pretty JupyterLite button to docs #361

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
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ repos:
rev: v6.2.4
hooks:
- id: rstcheck
args: ['--ignore-directives=tabs,toctree,autoclass', '--report-level=warning']
args: ['--ignore-directives=tabs,toctree,autoclass,cssclass', '--report-level=warning']
17 changes: 17 additions & 0 deletions docs/assets/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.try-in-jupyterlite-button a {
background-color: #f7dc1e;
color: black;
text-decoration: none;

border: none;
padding: 5px 10px;
border-radius: 15px;
font-family: vibur;
font-size: larger;
box-shadow: 0 2px 5px rgba(108, 108, 108, 0.2);
}

.try-in-jupyterlite-button a:hover {
color: white;
box-shadow: 0 2px 5px #f7dc1e;
}
5 changes: 5 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
html_theme = "pydata_sphinx_theme"
html_theme_options = {"github_url": "https://github.com/geojupyter/jupytergis"}

html_static_path = ["assets"]
html_css_files = [
"css/custom.css",
]

extensions = [
"jupyterlite_sphinx",
"sphinx.ext.autodoc",
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
JupyterGIS
==========

.. image:: https://jupyterlite.rtfd.io/en/latest/_static/badge.svg
:alt: Try JupyterGIS now in JupyterLite!
:target: lite/
.. cssclass:: try-in-jupyterlite-button

`Try it with JupyterLite! <lite/>`_

JupyterGIS is a JupyterLab extension for collaborative GIS (Geographical Information System). It is designed to
allow multiple people to work on the same geospatial project simultaneously, facilitating discussion and collaboration
Expand Down
Loading