Skip to content

Commit 8f5c150

Browse files
committed
Update Binder docs and design
1 parent 21072dc commit 8f5c150

File tree

7 files changed

+47
-30
lines changed

7 files changed

+47
-30
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# binder
1+
# `mybinder.org` user documentation
22

33
[![Documentation Status](https://readthedocs.org/projects/mybinder/badge/?version=latest)](https://mybinder.readthedocs.io/en/latest/?badge=latest)
44
[![Join the chat at https://gitter.im/jupyterhub/binder](https://badges.gitter.im/jupyterhub/binder.svg)](https://gitter.im/jupyterhub/binder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -39,7 +39,7 @@ nox -s docs
3939
or to launch a live server that re-builds and re-loads pages as you save files:
4040

4141
```bash
42-
nox -s docs-live
42+
nox -s docs -- live
4343
```
4444

4545
Alternatively, you may build the documentation directly with Sphinx:

doc/_data/scripts/gen_federation_md.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@
88
template_binderhub = """
99
```{{grid-item-card}}
1010
:text-align: center
11-
:class-header: bg-light
11+
:class-header: sd-text-dark
1212
:class-body: sd-p-4 sd-m-auto
13-
:class-footer: bg-light
13+
:class-card: bg-light
1414
:text-align: center
1515
:link: {URL_BINDERHUB}
1616
1717
**{BINDERHUB_SUBDOMAIN}**
1818
1919
^^^
2020
21-
<img src="{LOGO}" style="max-height: 5em; min-height: 2em;" />
21+
<img src="{LOGO}" class="dark-light" style="max-height: 5em; min-height: 2em;" />
2222
```
2323
2424
"""

doc/_data/scripts/gen_support_md.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@
2525
output += dedent(f"""
2626
```{{grid-item-card}}
2727
:text-align: center
28-
:class-header: bg-light
28+
:class-card: bg-light
2929
:class-body: sd-p-4 d-flex sd-m-auto
3030
:link: {supporter["url"]}
3131
:text-align: center
3232
3333
**{supporter["name"]}**
3434
^^^
3535
36-
<img src="{supporter['logo']}" style="max-height:5em;min-height:2em;" />
36+
<img src="{supporter['logo']}" class="dark-light" style="max-height:5em;min-height:2em;" />
3737
3838
```
3939

doc/about/federation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ federation, check out [](federation/joining).
1919

2020
Below is a list of the current member hubs in the BinderHub Federation:
2121

22+
% generate with doc/_data/scripts/gen_federation_md.py
2223
```{include} /_data/snippets/federation_md.txt
2324
```
2425

doc/about/team.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This page contains basic information about the people and tools behind the Binde
55
(team:members)=
66
## The Binder Team
77

8-
The Binder Team is a subset of the {external+tc:doc}`JupyterHub Core Team <team>`.
8+
The Binder Team is a subset of the {external:tc:ref}`JupyterHub Core Team <jupyterhub-team>`.
99
This group builds and maintains our open source projects, operates the cloud infrastructure at mybinder.org, and broadly supports the mission of the Binder project for the communities we serve.
1010

1111
The service at `mybinder.org` is powered by a collection of BinderHub

doc/conf.py

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,38 @@
4646
#
4747
html_theme_options = {
4848
"use_edit_page_button": True,
49-
"google_analytics_id": "UA-101904940-3",
50-
"github_url": "https://github.com/jupyterhub/binder",
51-
"twitter_url": "https://twitter.com/mybinderteam",
49+
"analytics": {
50+
"google_analytics_id": "UA-101904940-3",
51+
},
5252
"icon_links": [
5353
{
5454
"name": "Go to mybinder.org",
5555
"url": "https://mybinder.org",
5656
"icon": "_static/favicon.png",
5757
"type": "local",
58-
}
58+
},
59+
{
60+
"name": "GitHub repository",
61+
"url": "https://github.com/jupyterhub/binder",
62+
"icon": "fa-brands fa-github",
63+
},
64+
{
65+
"name": "Twitter account",
66+
"url": "https://twitter.com/mybinderteam",
67+
"icon": "fa-brands fa-twitter",
68+
},
69+
{
70+
"name": "Community Forum",
71+
"url": "https://discourse.jupyter.org/c/binder/12",
72+
"icon": "fa-brands fa-discourse",
73+
},
5974
],
6075
"navbar_align": "left",
6176
"navbar_end": ["theme-switcher", "navbar-icon-links", "support-button"],
6277
"logo": {
6378
"image_light": "images/logo.png",
6479
"image_dark": "images/logo-dark.png",
65-
}
80+
},
6681
}
6782

6883
html_context = {

noxfile.py

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,27 @@
33
- ref: https://nox.thea.codes/en/stable/
44
"""
55
import nox
6-
from pathlib import Path
76

87
nox.options.reuse_existing_virtualenvs = True
98

9+
build_command = ["-b", "html", "doc", "doc/_build/html"]
1010

11-
@nox.session
11+
@nox.session(python="3.9")
1212
def docs(session):
1313
session.install("-r", "doc/doc-requirements.txt")
14-
session.run("sphinx-build", "-b=html", "doc/", "doc/_build/html")
15-
16-
17-
@nox.session(name="docs-live")
18-
def docs_live(session):
19-
session.install("-r", "doc/doc-requirements.txt")
20-
session.install("sphinx-autobuild")
21-
session.run(
22-
"sphinx-autobuild",
23-
"--re-ignore",
24-
"doc/_data*",
25-
"-b=html",
26-
"doc/",
27-
"doc/_build/html",
28-
)
14+
if "live" in session.posargs:
15+
AUTOBUILD_IGNORE = [
16+
"*/.github/*",
17+
"*/_data/*",
18+
"*/howto/languages.rst",
19+
"*/howto/user_interface.rst",
20+
"*/howto/lab_workspaces.rst",
21+
"*/using/config_files.rst",
22+
]
23+
cmd = ["sphinx-autobuild"]
24+
for folder in AUTOBUILD_IGNORE:
25+
cmd.extend(["--ignore", f"*/{folder}/*"])
26+
cmd.extend(build_command)
27+
session.run(*cmd)
28+
else:
29+
session.run("sphinx-build", *build_command)

0 commit comments

Comments
 (0)