Skip to content

Commit

Permalink
X3
Browse files Browse the repository at this point in the history
  • Loading branch information
krotesk committed Nov 17, 2023
2 parents 0bfb619 + 2c30a55 commit e6db93a
Show file tree
Hide file tree
Showing 37 changed files with 286 additions and 79 deletions.
15 changes: 15 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py

python:
install:
- requirements: docs/doc-requirements.txt
2 changes: 1 addition & 1 deletion README.es-ES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Jupyter

*Leer en otros idiomas: [English](README.md), [Español](README.es-ES.md), [Português](README.pt-BR.md)*
*Leer en otros idiomas: [English](README.md), [Español](README.es-ES.md), [Português](README.pt-BR.md), [Français](README.fr-FR.md)*

Meta paquete de Jupyter para su instalación y documentación.

Expand Down
31 changes: 31 additions & 0 deletions README.fr-FR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Jupyter

*Lire ceci dans d'autres langues: [English](README.md), [Español](README.es-ES.md), [Português](README.pt-BR.md)*

Jupyter metapackage pour installation et docs.

## Faire tourner les docs localement
D'abord naviguer dans le répertoire `/docs` et créer un environment `conda` :

```bash
conda env create -f environment.yml
```

Activer l'environment:

```bash
source activate jupyter_docs
```

Construire les docs:

```bash
make clean
make html
```

Les docs seront construit dans `build/html`. Ils peuvent être vus dans `build/html/index.html` ou en démarrant le serveur HTTP puis en naviguant sur `0.0.0.0:8000` dans votre navigateur web.
```bash
python3 -m http.server
```

16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Jupyter

<<<<<<< HEAD
*Read this in other languages: [English](README.md), [Español](README.es-ES.md), [Russian](README.ru-RU.md), [Português](README.pt-BR.md)*
=======
*Read this in other languages: [English](README.md), [Español](README.es-ES.md), [Português](README.pt-BR.md), [Français](README.fr-FR.md)*
>>>>>>> 2c30a5562b0da9ecf51f32d71fd4830bc9496229
Jupyter metapackage for installation and docs.
Jupyter metapackage for installation and documents

## Documentation structure

Expand All @@ -13,11 +17,11 @@ It is written in a combination of [reStructuredText](https://docutils.sourceforg

## Build the documentation locally

There are a few ways to build the documentation, see below for instructions:
There are a few ways to build the documentation; see below for instructions:

### Build the documentation automatically with `nox`

The easiest way to build the documentation locally is by using the [`nox` command line tool](https://nox.thea.codes/). This tool makes it easy to automate commands in a repository, and we have included a `docs` command to quickly install the dependencies and build the the documentation.
The easiest way to build the documentation locally is by using the [`nox` command line tool](https://nox.thea.codes/). This tool makes it easy to automate commands in a repository, and we have included a `docs` command to quickly install the dependencies and build the documentation.

To build and preview the site locally, follow these steps:

Expand Down Expand Up @@ -52,7 +56,7 @@ To start this live server, use the following `nox` command:
$ nox -s docs-live
```

When the build is finished, go to the URL that is displayed. It should show a live preview of your doucmentation.
When the build is finished, go to the URL that is displayed. It should show a live preview of your documentation.

To stop serving the website, press **`Ctrl`**-`C` in your terminal

Expand Down Expand Up @@ -99,8 +103,8 @@ then build the releases and publish them to PyPI.

The steps involved:

1. install tbump: `pip install tbump`
2. tag and publish the release `tbump $NEW_VERSION`.
1. Install tbump: `pip install tbump`
2. Tag and publish the release `tbump $NEW_VERSION`.

That's it!

Expand Down
2 changes: 1 addition & 1 deletion README.pt-BR.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Jupyter

*Ler em outros idiomas: [English](README.md), [Español](README.es-ES.md), [Português](README.pt-BR.md)*
*Ler em outros idiomas: [English](README.md), [Español](README.es-ES.md), [Português](README.pt-BR.md), [Français](README.fr-FR.md)*

Metapacote de Jupyter para instalação e documentação.

Expand Down
2 changes: 1 addition & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: jupyter_docs
dependencies:
- python=3.7
- python=3.10
- pip:
- -r doc-requirements.txt
Binary file added docs/source/_static/_images/jupyterlab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# November 30, 2021

**Date:** Novermber 30, 2021, at 8am Pacific (your [timezone](https://arewemeetingyet.com/Los%20Angeles/2021-11-30/8:00/Jupyter%20Community%20Call))
**Date:** November 30, 2021, at 8am Pacific (your [timezone](https://arewemeetingyet.com/Los%20Angeles/2021-11-30/8:00/Jupyter%20Community%20Call))

**[Discourse](https://discourse.jupyter.org/t/jupyter-community-calls/668)**

Expand Down
2 changes: 1 addition & 1 deletion docs/source/community/community-call-notes/2022-april.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This is a place to make short announcements (without a need for discussion).

## Agenda Items

* **[JupyterLab-LaTeX UX improvements PR](https://github.com/jupyterlab/jupyterlab-latex/pull/192)** Result of 2 semesters of work by [Junior Design Capstone class](https://techstyle.lmc.gatech.edu/cs-tech-comm-junior-design-sequence/) team from Georgia Tech done for client (Axle Informatics/NIH). Project included a user reasearch section which is summarized in PR. New features highlights:
* **[JupyterLab-LaTeX UX improvements PR](https://github.com/jupyterlab/jupyterlab-latex/pull/192)** Result of 2 semesters of work by [Junior Design Capstone class](https://techstyle.lmc.gatech.edu/cs-tech-comm-junior-design-sequence/) team from Georgia Tech done for client (Axle Informatics/NIH). Project included a user research section which is summarized in PR. New features highlights:
* Preview button
* Formatting buttons (bold, italic, underlined, subscript, superscript)
* Autocomplete for common LaTeX tags (i.e. `\subsection`)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/community/community-call-notes/2022-march.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ This is a place to make short announcements (without a need for discussion).

## Agenda Items

With time changes, this meeting was accidentally double-booked with the Jupyter Secuirty meeting! Since we had an open agenda before the community call, our notes overlap with theirs.
With time changes, this meeting was accidentally double-booked with the Jupyter Security meeting! Since we had an open agenda before the community call, our notes overlap with theirs.

For notes from this call, please refer to the [March 29, 2022 jupyter/security meeting notes!](https://github.com/jupyter/security/tree/main/meetings/2022-03-29.md)
2 changes: 1 addition & 1 deletion docs/source/community/community-call-notes/2022-october.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ For more discussion on the format of these calls, see the thread [here](https://
* https://github.com/deathbeds/importnb
* https://github.com/tonyfast/tonyfast
* "Spooky-ber Note-boo-ks" with [jupyterlab-deck](https://github.com/deathbeds/jupyterlab-deck) and a history of presenting in notebooks and a reporting deck (with Robot Framework).
* **Debra Chen, Niko Zeng**: Invitation for joint-holding comminity meetup
* **Debra Chen, Niko Zeng**: Invitation for joint-holding community meetup

## Other Links Shared

Expand Down
7 changes: 6 additions & 1 deletion docs/source/community/content-community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ the Jupyter community, share new ideas and discussions, and connect with one ano
This often happens within specific sub-project (more information below), though
there are also occasional community-wide meetings.

Some of these meetings are recorded and uploaded to our `YouTube channel <https://www.youtube.com/ipython>`_.
**Please do not record meetings on your own.** Some of our meetings include both
on-the-record and off-the-record segments; off-record segments are not recorded or
published.

This following calendar shows the various meetings and events from Jupyter sub-projects:

.. raw:: html
Expand Down Expand Up @@ -60,7 +65,7 @@ following pages should help you find the information for each.


**JupyterHub meetings** happen monthly. For a calendar of future team meetings, see
`the JupyterHub team compass repository <https://jupyterhub-team-compass.readthedocs.io/en/latest/meetings.html>`_.
`the JupyterHub team compass repository <https://jupyterhub-team-compass.readthedocs.io/en/latest/meetings/index.html>`_.

**JupyterLab meetings** happen weekly. For more information about when these meetings happen,
as well as notes from each meeting, see `the JupyterLab README <https://github.com/jupyterlab/jupyterlab#weekly-dev-meeting>`_.
Expand Down
9 changes: 9 additions & 0 deletions docs/source/contributing/content-contributor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,12 @@ be a positive and helpful member of this community. Whether it **participating i
**offering to help others**, **coming to community meetings**, or **teaching others about Jupyter**,
there are many ways to improve the Jupyter community. For more information about this, we
recommend starting with the :ref:`community-guide`.

Getting Access to Jupyter Managed Accounts
------------------------------------------

As a contributor, you may need to access accounts managed by Jupyter, for instance,
to write a blog post or update information posted to a Jupyter site.

To request access, email the security group at `[email protected]`, or make
an issue on the `Jupyter Security subproject repo <https://github.com/jupyter/security/issues/new>`_.
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ including partial or in-progress work, is appreciated.
5. Open a pull request to the repository with `[WIP]` appended to the front
so that the core team is aware that you are actively pursuing the issue.
When creating a pull request, make sure that the title clearly and concisely
described what your code does. For example, we might use the title "Updated
describes what your code does. For example, we might use the title "Updated
error message on ExampleException". In the body of the pull request, make
sure that you include the phrase "Closes #issue-number-here", where the
issue number is the issue number of the issue that you are addressing in
Expand Down
4 changes: 2 additions & 2 deletions docs/source/contributing/dev-contributions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Developer Guide
releasing.rst

Whether you are a new contributor or a seasoned developer, we're pleased that
you are working on Jupyter. We hope you find the Developer Guide is useful.
Please suggest changes or ask questions about the contents. Thanks!
you are working on Jupyter. We hope you find the Developer Guide useful.
Please feel free to suggest changes or ask questions about the content. Thanks for your contribution!

If you are interested in installing a specific project from source, each
project has documentation on ReadTheDocs. For example, IPython documentation
Expand Down
121 changes: 109 additions & 12 deletions docs/source/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,110 @@ Glossary

.. glossary::

`client-server-architecture <https://en.wikipedia.org/wiki/Client%E2%80%93server_model>`_
A `software design pattern <https://en.wikipedia.org/wiki/Design_pattern>`_ used by
Jupyter applications like **JupyterLab**. With this pattern, a server program (running
on a user's computer or on a server that can be accessed over a business or public
network) provides access to stored information (in JupyterLab's case, documents in
a folder such as notebooks and other data files), and a client program (the web
application and editing interface for JupyterLab in this case) connects to the
server program to view and interact with that data.

console
In modern times, a `console <https://en.wikipedia.org/wiki/System_console>`_ refers to a simple text-based program where you type commands for your
computer to run, also commonly called a `terminal <https://en.wikipedia.org/wiki/Computer_terminal>`_.

command line
The terminal or console window where you type commands.
A simple text-based program where you type commands for your computer to run, also
called a `terminal <https://en.wikipedia.org/wiki/Computer_terminal>`_ or `console <https://en.wikipedia.org/wiki/System_console>`_.

Command Prompt
On Windows, this is the application where commands are typed into
a window for execution.
a window for execution. Also see `console <https://en.wikipedia.org/wiki/System_console>`_,
**command line**, or `terminal <https://en.wikipedia.org/wiki/Computer_terminal>`_.

conda
The package manager for Anaconda.
The package management tool for Anaconda, which allows for easy
installation of Python libraries and other tools into an **environment**.

config
Refers to the configuration files and process.
Refers to the configuration files, and related processes that affect how
Jupyter behaves.

environment
The name for the installed software, configurations, tools, and
`environment variables <https://en.wikipedia.org/wiki/Environment_variable>`_
that collectively define what capabilities a computer system has and how
it behaves. Missing or incorrect software, configurations or environment variables
can cause software to malfunction, or software development processes to fail. See
`this link <https://en.wikipedia.org/wiki/Runtime_system#Relation_to_runtime_environments>`_
for more information.

environment variable
See `this wiki link <https://en.wikipedia.org/wiki/Environment_variable>`_ for for information.

ipynb
The file extension (.ipynb) for saved notebook files, commonly
authored and edited with Jupyter web applications such as
JupyterLab or Jupyter Notebook. It stands for "IPython Notebook".

IPython
The earliest ancestor of **Project Jupyter**. It began as an improved
interactive Python **REPL**, then expanded to also contain a stored
notebook document format (.ipynb) and related tools, a web based
document authoring and editing tool (IPython Notebook), and more.
After the project became large enough, IPython was split into many
separate projects under the **Project Jupyter** umbrella through
**The Big Split.**

IPython Notebook
An early ancestor of the Jupyter Notebook application, this was one of
the first web-based applications for authoring and editing computational
notebook documents.

ipywidgets
A `python package for Jupyter <https://github.com/jupyter-widgets/ipywidgets>`_
that allows Notebook applications to create and embed interface components
like sliders or buttons in their notebooks.

Jovyan
A term for fans of Jupyter and members of the Jupyter community. This term
is `derived from <https://jupyter--681.org.readthedocs.build/en/681/community/content-community.html#what-is-a-jovyan>`_
the astronomical term "Jovian", meaning "Like Jupiter".

Jupyter
See **Project Jupyter**. Also occasionally used to refer to one of the Jupyter
frontend notebook editing applications (**Jupyter Notebook** or **JupyterLab**)
based on the context it's used in (this ambiguous usage can lead to
confusion, it's better to use the actual name of the application).

Jupyter Notebook (Application)
A simplified web application for authoring and editing computational
notebooks in the **.ipynb** format (a notebook file is also commonly referred
to as a Jupyter Notebook).

Jupyter Notebook (File Format)
A common name for a saved **.ipynb** Notebook file. For instance,
"I just made a Jupyter Notebook summarizing our lab results, I can
send it to you later today."

JupyterLab
A modern web application for authoring and editing interactive
computational notebooks.

kernel
A kernel provides programming language support in Jupyter. IPython is
A kernel provides programming language support in Jupyter. **IPython** is
the default kernel. Additional kernels include R, Julia, and many more.

Notebook
The generic name for a computational notebook document, such as a saved
.ipynb file format created by JupyterLab. Also sometimes used as a shorthand
to refer to Jupyter Notebook, the notebook editing application.

Notebook Dashboard
The notebook user interface which shows a list of the notebooks, files,
and subdirectories in the directory where the notebook server is
started.
The notebook user interface in the **Jupyter Notebook Application** (see above)
which shows a list of the notebooks, files, and subdirectories in the directory
where the notebook server is started.

pip
Python package manager.
Expand All @@ -35,12 +118,26 @@ Glossary
Not available in Jupyter. In IPython 3, profiles are collections of
configuration and runtime files.

Project Jupyter
The umbrella project for many related tools for interactive computing
with interactive notebooks

REPL
read-eval-print-loop.
Stands for "read-eval-print-loop". An `REPL <https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop>`_
is a program that reads user commands and inputs, evaluates them, and prints results for the user to view.
These steps run in a perpetual loop, allowing the user to prototype code,
interact with data, and view results on-the-fly, since the data and code
stay open in memory after evaluation while the REPL is running.

terminal
A window used to type in commands to be executed (Linux and OS X).
In modern times, a `terminal <https://en.wikipedia.org/wiki/Computer_terminal>`_ refers to a simple text-based program where you type commands for your
computer to run, also commonly called a `console <https://en.wikipedia.org/wiki/System_console>`_.

The Big Split
An event and effort undertaken around 2015 by **IPython** developers to split up
the then-massive IPython project into a series of smaller, more focused
sub-projects under the Project Jupyter umbrella.

widget
A user interface component, similar to a plugin, that allows customized
input, such as a slider.
A user interface component from `ipywidgets <https://github.com/jupyter-widgets/ipywidgets>`_,
similar to a plugin, that allows customized input, such as a slider.
Loading

0 comments on commit e6db93a

Please sign in to comment.