Skip to content

Commit

Permalink
Merge pull request #523 from choldgraf/sidebars
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf committed Jul 22, 2020
2 parents ea4f79e + b078fb6 commit 9e77692
Show file tree
Hide file tree
Showing 52 changed files with 676 additions and 505 deletions.
3 changes: 1 addition & 2 deletions docs/environment.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: jupyter_docs
dependencies:
- python=3.7
- sphinx_rtd_theme
- pip:
- -r doc-requirements.txt
- -r doc-requirements.txt
Binary file added docs/source/_static/_images/favicon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 5 additions & 7 deletions docs/source/community/community-call-notes/index.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
.. _community-call-notes:

======================
Jupyter Community Call
======================
====================
Community Call Notes
====================

The Jupyter Community Call is an open video call. Think of this as a "monthly, virtual JupyterCon". It's a place for *anyone* to announce and share fun things happening in the Jupyter community. Everyone is welcome (even if you're not presenting). We record these videos and post them on YouTube. For more information, `read this discourse thread <https://discourse.jupyter.org/t/all-jupyter-community-calls/668>`__.

**Previous Community Calls**
The Jupyter Community Call is an open video call. Think of this as a "monthly, virtual JupyterCon". It's a place for *anyone* to announce and share fun things happening in the Jupyter community. Everyone is welcome (even if you're not presenting). We record these videos and post them on YouTube. For more information, `read this discourse thread <https://discourse.jupyter.org/t/all-jupyter-community-calls/668>`__.

.. toctree::
:maxdepth: 1

September 2019 <2019-september.md>
August 2019 <2019-august.md>
June 2019 <2019-june.md>
June 2019 <2019-june.md>
May 2019 <2019-may.md>
April 2019 <2019-april.md>
March 2019 <2019-march.md>
Expand Down
61 changes: 43 additions & 18 deletions docs/source/community/content-community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,20 @@ provide information about the Jupyter community such as background, events,
and communication channels. As our community is highly dynamic, information
may change, and we will do our best to keep it up to date.

.. TODO: remove this hidden toctree when left sidebar TOCs work in pydata sphinx theme
Monthly Meetings
----------------
.. toctree::
:hidden:

community-call-notes/index

Jupyter Community Meetings
==========================

The Jupyter community often meets (usually on-line) in order to discuss matters in
the Jupyter community, share new ideas and discussions, and connect with one another.
This often happens within specific sub-project (more information below), though
there are also occasional community-wide meetings.

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

Expand All @@ -21,6 +32,25 @@ This following calendar shows the various meetings and events from Jupyter sub-p
<iframe src="https://calendar.google.com/calendar/embed?height=600&amp;wkst=1&amp;bgcolor=%23ffffff&amp;ctz=America%2FLos_Angeles&amp;src=ZGdwZDM2ZjQzZXQ5Z3JhYm42dGRpbjZwbWNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ&amp;src=bTNoZWs2OWRhZzczODF1bXQ4a2NqZDc1dTRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ&amp;src=YXFwa3VpNXE3b2kzMnBrOXRjcDUzaG5zc2NAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ&amp;src=ZDE4NzR1cjZmZGh1ajBzbmpuaWxhYzJubGNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ&amp;src=cGlhaGluZWpqcjZzc3ZpOGlrbWpqb3A2cm9AZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ&amp;color=%23AD1457&amp;color=%23EF6C00&amp;color=%23616161&amp;color=%23F6BF26&amp;color=%239E69AF" style="border:solid 1px #777" width="800" height="600" frameborder="0" scrolling="no"></iframe>


Jupyter-wide meetings
---------------------

**All-Jupyter Community Calls** generally happen on the last Tuesday of the month,
and are focused around demonstrations and sharing information across all of the Jupyter projects.

- Find information on `this Discourse thread <https://discourse.jupyter.org/t/all-jupyter-community-calls/668>`_.
- Watch previous calls on `our YouTube channel <https://www.youtube.com/playlist?list=PLUrHeD2K9Cmkoamm4NjLmvXC4Y6E1o8SP>`_.
- Read the `notes from previous calls <community-call-notes/index.html>`_.

In addition, you can find the notes from previous community meetings below.

.. toctree::

community-call-notes/index

Jupyter Project meetings
------------------------

The core developers of various Jupyter sub-projects have regular meetings to
discuss and demo what they have been working on, discuss future plans,
and bootstrap conversation. These meetings are public and you are welcome to join remotely.
Expand All @@ -29,14 +59,6 @@ Each team has their own processes around logistics and planning for the team mee
following pages should help you find the information for each.


**All-Jupyter Community Calls** happen on the last Tuesday of every month, and are focused around demonstrations
and sharing information across all of the Jupyter projects.

- Find information on `this Discourse thread <https://discourse.jupyter.org/t/all-jupyter-community-calls/668>`_.
- Watch previous calls on `our YouTube channel <https://www.youtube.com/playlist?list=PLUrHeD2K9Cmkoamm4NjLmvXC4Y6E1o8SP>`_.
- Read the `notes from previous calls <community-call-notes/index.html>`_.


**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>`_.

Expand All @@ -52,7 +74,7 @@ We recommend checking it periodically for new information about when meetings ar


Jupyter communications
----------------------
======================

As a general rule, most project-wide conversation happens in the
`Jupyter community forum <https://discourse.jupyter.org>`_. There are also many other
Expand All @@ -69,22 +91,25 @@ relevant information.


Governance
----------
==========

- Steering council: Information about the steering council and its members
can be found on the `Jupyter website <https://jupyter.org>`_.
can be found on the `Jupyter website <https://jupyter.org/about>`_.
- Information about Jupyter's governance process can be found on
`the Jupyter governance website <https://jupyter.org/governance>`_.
- Jupyter Enhancement Proposal (JEP) process: Details about the process can
be found in the `jupyter/enhancement-proposals GitHub repo <https://github.com/jupyter/enhancement-proposals>`_.
be found in the `enhancement proposals website <https://jupyter.org/enhancement-proposals>`_.


Code of conduct
---------------
===============

Information can be found in the `Jupyter Governance repo on GitHub <https://github.com/jupyter/governance>`_.
Information can be found in the
`Jupyter Code of Conduct page <https://jupyter.org/governance/conduct/code_of_conduct.html>`_.


Running Jupyter Events
----------------------
======================

Members of the Jupyter community often get together to share what they're
working on, to work together, and to teach and learn from one another.
Expand Down Expand Up @@ -124,7 +149,7 @@ is worth it!


What is a Jovyan?
-----------------
=================

You may see the word **Jovyan** used in Jupyter tools (such as the user ID in the
`Jupyter Docker stacks <https://github.com/jupyter/docker-stacks?>`_ or referenced in
Expand Down
6 changes: 6 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

html_theme = 'pydata_sphinx_theme'
html_logo = '_static/_images/jupyter.svg'
html_favicon = '_static/_images/favicon.png'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand Down Expand Up @@ -148,6 +149,11 @@
'jupyterclient': ('https://jupyter-client.readthedocs.io/en/latest/', None),
'qtconsole': ('https://jupyter.org/qtconsole/dev/', None),
'jupytercore': ('https://jupyter-core.readthedocs.io/en/latest/', None),
'hub': ('https://jupyterhub.readthedocs.io/en/latest/', None),
'z2jh': ('https://zero-to-jupyterhub.readthedocs.io/en/latest/', None),
'tljh': ('https://tljh.jupyter.org/en/latest/', None),
'bhub': ('https://binderhub.readthedocs.io/en/latest/', None),
'lab': ('https://jupyterlab.readthedocs.io/en/latest/', None),
}

intersphinx_cache_limit = 5
Expand Down
18 changes: 9 additions & 9 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Start Here

Sustainability and growth

* - :doc:`Architecture <architecture/content-architecture>`
* - :doc:`Architecture <projects/architecture/content-architecture>`

What is Jupyter?

- :doc:`Contributor Guides <contributor/content-contributor>`
- :doc:`Contributor Guides <contributing/content-contributor>`

How to contribute to the projects

* - :doc:`Narratives and Use Cases <projects/use-cases/content-user>`
* - :doc:`Narratives and Use Cases <use/use-cases/content-user>`

Narratives of common deployment scenarios

Expand All @@ -49,7 +49,7 @@ Start Here

Documentation for users

- :doc:`Advanced <projects/advanced/content-advanced>`
- :doc:`Advanced <use/advanced/content-advanced>`

Documentation for advanced use-cases

Expand Down Expand Up @@ -88,15 +88,15 @@ Sub-project documentation
---
Kernels
^^^^^^
* `IPython <https://ipython.readthedocs.io/en/stable>`_
* `IPython <https://ipython.readthedocs.io/en/stable>`__
* `IRkernel <https://irkernel.github.io>`_
* `IJulia <https://github.com/JuliaLang/IJulia.jl>`_
* `Community maintained kernels <https://github.com/ipython/ipython/wiki/IPython-kernels-for-other-languages>`_

---
IPython
^^^^^^
* `IPython <http://ipython.readthedocs.io/en/stable>`_
* `IPython <http://ipython.readthedocs.io/en/stable>`__
* `ipykernel <https://ipython.readthedocs.io/en/stable>`_
* `ipyparallel <https://ipyparallel.readthedocs.io/en/latest>`_

Expand Down Expand Up @@ -133,12 +133,12 @@ Table of Contents

content-quickstart

.. _tech-overview:
.. _jupyter-using:

.. toctree::
:maxdepth: 1
:maxdepth: 2

architecture/content-architecture.rst
use/using

.. _jupyter-subprojects:

Expand Down

0 comments on commit 9e77692

Please sign in to comment.