Skip to content

Commit

Permalink
Re-arrange get started docs and add theme configuration (#595)
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf committed Dec 28, 2021
1 parent 1aab87d commit 427fc72
Show file tree
Hide file tree
Showing 9 changed files with 118 additions and 94 deletions.
1 change: 0 additions & 1 deletion .circleci/artifact_path

This file was deleted.

38 changes: 0 additions & 38 deletions .circleci/config.yml

This file was deleted.

1 change: 1 addition & 0 deletions docs/doc-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ sphinx-intl
myst_parser
nbsphinx
pydata-sphinx-theme
sphinxext-rediraffe
sphinx-panels
39 changes: 39 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.graphviz', # Add the graphviz extension
'sphinxext.rediraffe',
'myst_parser',
'sphinx_panels'
]
Expand Down Expand Up @@ -86,6 +87,44 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_context = {
# "github_url": "https://github.com", # or your GitHub Enterprise interprise
"github_user": "jupyter",
"github_repo": "jupyter",
"github_version": "master",
"doc_path": "docs/source",
}

html_theme_options = {
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/jupyter/jupyter",
"icon": "fab fa-github-square",
},
{
"name": "GitLab",
"url": "https://discourse.jupyter.org",
"icon": "fab fa-discourse",
},
{
"name": "Twitter",
"url": "https://twitter.com/projectjupyter",
"icon": "fab fa-twitter-square",
},
],
"external_links": [
{"name": "jupyter.org", "url": "https://jupyter.org"},
],
"use_edit_page_button": True,
}

# Re-directs for pages that were moved
rediraffe_redirects = {
"content-quickstart.rst": "start/index.md",
"tryjupyter.rst": "start/index.md",
}

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d'
Expand Down
9 changes: 0 additions & 9 deletions docs/source/content-quickstart.rst

This file was deleted.

18 changes: 12 additions & 6 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Jupyter Project Documentation

**Welcome to the Jupyter Project documentation**. This website acts as "meta" documentation
for the Jupyter ecosystem. It has a collection of resources to navigate the tools
and communities in this ecosystem, and to help you get started.
**Welcome to the Jupyter Project documentation**. This website acts as "meta" documentation for the Jupyter ecosystem.
It has a collection of resources to navigate the tools and communities in this ecosystem, and to help you get started.

## Start Here

These are a few high-level topics to help you learn more about the Jupyter community and ecosystem.

```{list-table}
:class: front_page_table
* - {doc}`Get started with Jupyter Notebook <content-quickstart>`
* - {doc}`Get started with Jupyter Notebook <start/index>`
Try the notebook
Expand Down Expand Up @@ -52,6 +53,9 @@ and communities in this ecosystem, and to help you get started.

## Sub-project documentation

Sub-projects are major technical and community efforts, and generally have their own documentation for their communities.
Below is a list of documentation for major parts of the Jupyter ecosystem.

```{panels}
User Interfaces
^^^^^^
Expand Down Expand Up @@ -129,12 +133,15 @@ Widgets

## Table of Contents

The rest of the documentation in this site covers major use-cases of the Jupyter ecosystem, as well as topics that will help you navigate the various parts of the Jupyter community.
For more in-depth documentation about a specific tool, we recommend checking out that tool's documentation (see the list above).

(user-docs)=

```{toctree}
:maxdepth: 2
content-quickstart
start/index
```

(jupyter-using)=
Expand Down Expand Up @@ -173,7 +180,6 @@ contributing/content-contributor
reference/content-reference
```


## Resources

```{csv-table}
Expand Down
4 changes: 2 additions & 2 deletions docs/source/projects/architecture/content-architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@ JupyterLab
JupyterLab is a flexible, extensible interface for interactive computing. Below
are a few links that are useful for understanding the JupyterLab architecture.

* :doc:`JupyterLab document model <lab:developer/documents>`
* :doc:`JupyterLab notebook model <lab:developer/notebook>`
* :ref:`JupyterLab document model <lab:kernel-backed-documents>`
* :ref:`JupyterLab notebook model <lab:notebook>`
* :doc:`Design patterns in JupyterLab <lab:developer/patterns>`

Projects overview
Expand Down
64 changes: 64 additions & 0 deletions docs/source/start/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
(tryjupyter)=

# Try Jupyter

```{contents} Contents
:local:
```

These sections describe a few ways to get started with some of the most-commonly used tools in the Jupyter ecosystem.

## Try in Your Browser. No Installation Needed.


**Try Jupyter** (https://try.jupyter.org) is a site for trying out the Jupyter Notebook, equipped with kernels for several different languages (Julia, R, C++, Scheme, Ruby) without installing anything.
Click the link below to go to the page.

```{link-button} https://try.jupyter.org
:type: url
:text: Click to Try Jupyter
:classes: btn-primary
```

When running the examples on the `Try Jupyter` site, you will get a temporary Jupyter
server running on mybinder.org which you can use to play around until you close your
browser session.

You can use this site to try a few of the major interactive computing interfaces created by the Jupyter community.
A description of each is below.

### Try the Classic Notebook interface

The *Classic Notebook* interface is a document-oriented interface that allows you to create, view, and execute code in a Jupyter Notebook.

The example should look like this:

**Notebook Dashboard**

```{image} ../_static/_images/tryjupyter_file.png
```

**Notebook Editor**

```{image} ../_static/_images/trynb.png
```

### Try the JupyterLab interface

The Jupyter Lab interface is a more extensible and composable interactive computing interface for more complex workflows.

Here's an example of what the JupyterLab interface looks like:

```{image} https://jupyter.org/assets/labpreview.webp
```

## Next step: install Jupyter locally

If you have tried Jupyter and like it, please use our [Installation Guide](install) to install Jupyter on your computer.

```{toctree}
:maxdepth: 2
../install
../running
```
38 changes: 0 additions & 38 deletions docs/source/tryjupyter.rst

This file was deleted.

0 comments on commit 427fc72

Please sign in to comment.