Skip to content

Commit

Permalink
Merge pull request #247 from Carreau/redoc
Browse files Browse the repository at this point in the history 
Cleanup the documentation page.
  • Loading branch information
@Carreau
Carreau authored Jan 17, 2018
2 parents 8691df6 + dbf8f04 commit 242bc7c
Show file tree
Hide file tree
Showing 6 changed files with 108 additions and 221 deletions.
46 changes: 46 additions & 0 deletions _data/documentation.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@


General:
Project-wide Documentation: https://jupyter.readthedocs.io
Contributing to Jupyter: https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html

User Interfaces:
JupyterLab: https://jupyterlab-tutorial.readthedocs.io/en/latest/
Jupyter Notebook: https://jupyter-notebook.readthedocs.io/en/stable/
Jupyter Console: https://jupyter-console.readthedocs.io/en/stable/
Qt Console : https://qtconsole.readthedocs.io/en/stable/

IPython:
IPython: https://ipython.readthedocs.io/en/stable/
IPyParallel: https://ipyparallel.readthedocs.io/en/stable/
Traitlets: https://traitlets.readthedocs.io/en/stable/

Kernels:
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/jupyter/jupyter/wiki/Jupyter-kernels

Widgets:
IPyWidgets/Jupyter Widgets: https://ipywidgets.readthedocs.io/en/latest/
widget-cookiecutter: https://github.com/jupyter-widgets/widget-cookiecutter/

Notebook Documents:
nbconvert: https://nbconvert.readthedocs.io/en/latest/
nbformat: https://nbformat.readthedocs.io/en/latest/
nbviewer: https://github.com/jupyter/nbviewer/

JupyterHub:
JupyterHub: https://jupyterhub.readthedocs.io/en/stable/
Zero to JupyterHub: https://zero-to-jupyterhub.readthedocs.io/en/latest/
nbgrader: https://nbgrader.readthedocs.io/en/latest/
All JupyterHub Projects...: https://github.com/jupyterhub

Deployment:
Docker Stacks: https://github.com/jupyter/docker-stacks
Kernel Gateway: https://jupyter-kernel-gateway.readthedocs.io/en/latest/

Foundations:
Jupyter Client: https://jupyter-client.readthedocs.io/en/latest/
Jupyter Core: https://jupyter-core.readthedocs.io/en/latest/
Jupyter Alabaster Theme: https://jupyter-alabaster-theme.readthedocs.io/en/latest/
20 changes: 10 additions & 10 deletions _includes/footer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
<div class="navbar-text">
<ul class="footer-text">
<li><a href="{{site.baseurl}}/index.html">Home</a></li>
{% for nav in site.data.nav.head %}
{% if nav.url %}
<li><a href="{{site.baseurl}}{{nav.url}}" target="_blank">{{nav.title}}</a></li>
{% else %}
{% for target_page in site.pages %}
{% if nav contains target_page.title %}
{%- for nav in site.data.nav.head %}
{%- if nav.url %}
<li><a href="{{site.baseurl}}{{nav.url}}" target="_blank">{{nav.title}}</a></li>
{%- else %}
{%- for target_page in site.pages %}
{%- if nav contains target_page.title %}
<li><a href="{{site.baseurl}}{{target_page.url}}">{{target_page.title}}</a></li>
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}
{%- endif %}
{%- endfor %}
{%- endif %}
{%- endfor %}
<!--{{ site.time}}-->
</ul>
<p>Copyright © {{site.time | date: '%Y' }} Project Jupyter - Last updated {{site.time | date: "%a, %b %d, %Y" }}</p>
Expand Down
30 changes: 15 additions & 15 deletions _includes/header.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,27 @@
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
{% for nav in site.data.nav.head %}
{% if nav.url %}
<li>
<a href="{{site.baseurl}}{{nav.url}}" class="tab" target="_blank">{{nav.title}}</a>
</li>
{% else %}
{% for targetpage in site.pages %}
{% if nav contains targetpage.title%}
{% if page.title == targetpage.title %}
{%- for nav in site.data.nav.head -%}
{%- if nav.url %}
<li>
<a href="{{site.baseurl}}{{nav.url}}" class="tab" target="_blank">{{nav.title}}</a>
</li>
{%- else -%}
{%- for targetpage in site.pages %}
{%- if nav contains targetpage.title -%}
{%- if page.title == targetpage.title %}
<li>
<a href class="tab navbar-active">{{targetpage.title}}</a>
</li>
{% else %}
{%- else %}
<li>
<a href="{{site.baseurl}}{{targetpage.url}}" class="tab">{{targetpage.title}}</a>
</li>
{% endif %}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}
{%- endif -%}
{%- endif -%}
{%- endfor -%}
{%- endif -%}
{%- endfor %}
</ul>
</div>
<!-- /.navbar-collapse -->
Expand Down
35 changes: 35 additions & 0 deletions _layouts/documentation.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: default
title: Documentation
---

<section>
<div class="header header-grey">
<h2>Documentation</h2>
<p>Browse the Jupyter universe for information.</p>
</div>
</section>
<section>
<div class="top-section-border">
<div class="container">
<div class="row docs-cards">
{%- for card in site.data.documentation -%}
<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="general-block" class="docs-card-heading">
<h4 class="">{{card[0]}}</h4>
</div>
<div class="docs-card-body">
<ul>
{%- for item in card[1] %}
<li><a href="{{item[1]}}">{{item[0]}}</a></li>
{%- endfor %}
</ul>
</div>
</div>
</div>
{%- endfor -%}
</div>
</div>
</div>
</section>
17 changes: 1 addition & 16 deletions css/documentation.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

.docs-card-heading {
padding: 16px;
background: #1976D2;
background: #F27624;
color: white;
font-size: 14px;
font-weight: normal;
Expand All @@ -47,18 +47,3 @@
padding: 4px 0px 4px 0px;
font-size: 14px;
}




/* MEDIA QUERIES */

@media screen and (max-width: 1200px) {
}

@media screen and (max-width: 992px) {
}

@media screen and (max-width: 768px) {

}
181 changes: 1 addition & 180 deletions documentation.html
View file
Original file line number Diff line number Diff line change
@@ -1,184 +1,5 @@
---
layout: default
layout: documentation
title: Documentation
permalink: /documentation
---


<style>
/*Styling for the community section */
/* Style for inter-repo links */
.link1 {
stroke: white;
stroke-width: 1;
}

/* Style for repo-contributor links */
.link2 {
stroke: #e6e6e6;
stroke-width: 2;
}

.node text {
pointer-events: none;
font: 0px sans-serif;
}
</style>


<section>
<div class="header header-grey">
<div class="container">
<div class="row">
<div class="col-xs-12">
<h2 class="doc">Documentation</h2>
<p>Browse documentation for everything in the Jupyter universe.</p>
</div>
</div>
</div>
</div>
</section>
<section>
<div class="section-white top-section-border">
<div class="container">
<div class="row docs-cards">

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="general-block" class="docs-card-heading">
<h4 class="">General</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://jupyter.readthedocs.io">Project-wide Documentation</a></li>
<li><a href="https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html">Contributing to Jupyter</a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="interfaces-block" class="docs-card-heading">
<h4 class="">User Interfaces</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://jupyterlab-tutorial.readthedocs.io/en/latest/">JupyterLab</a></li>
<li><a href="https://jupyter-notebook.readthedocs.io/en/stable/">Jupyter Notebook</a></li>
<li><a href="https://jupyter-console.readthedocs.io/en/stable/">Jupyter Console</a></li>
<li><a href="https://qtconsole.readthedocs.io/en/stable/">Qt Console</a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="ipython-block" class="docs-card-heading">
<h4 class="">IPython</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://ipython.readthedocs.io/en/stable/">IPython</a></li>
<li><a href="https://ipyparallel.readthedocs.io/en/stable/">IPyParallel</a></li>
<li><a href="https://traitlets.readthedocs.io/en/stable/">Traitlets</a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="kernels-block" class="docs-card-heading">
<h4 class="">Kernels</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://ipython.readthedocs.io/en/stable/">IPython</a></li>
<li><a href="https://irkernel.github.io/">IRkernel</a></li>
<li><a href="https://github.com/JuliaLang/IJulia.jl">IJulia</a></li>
<li><a href="https://github.com/jupyter/jupyter/wiki/Jupyter-kernels">Community maintained kernels</a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="widgets-block" class="docs-card-heading">
<h4 class="">Widgets</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://ipywidgets.readthedocs.io/en/latest/">IPyWidgets</a></li>
<li><a href="https://github.com/jupyter-widgets/widget-cookiecutter/">widget-cookiecutter</a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="conversion-block" class="docs-card-heading">
<h4 class="">Notebook Documents</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://nbconvert.readthedocs.io/en/latest/">nbconvert</a></li>
<li><a href="https://nbformat.readthedocs.io/en/latest/">nbformat</a></li>
<li><a href="https://github.com/jupyter/nbviewer/">nbviewer</a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="jupyterhub-block" class="docs-card-heading">
<h4 class="">JupyterHub</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://jupyterhub.readthedocs.io/en/stable/">JupyterHub</a></li>
<li><a href="https://zero-to-jupyterhub.readthedocs.io/en/latest/">Zero to JupyterHub</a></li>
<li><a href="https://nbgrader.readthedocs.io/en/latest/">nbgrader</a></li>
<li><a href="https://github.com/jupyterhub">All JupyterHub Projects&hellip;</a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="deployment-block" class="docs-card-heading">
<h4 class="">Deployment</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://github.com/jupyter/docker-stacks">Docker Stacks</a></li>
<li><a href="https://jupyter-kernel-gateway.readthedocs.io/en/latest/">Kernel Gateway</a></li>
</ul>
</div>
</div>
</div>

<div class="col-lg-4 col-md-6 col-sm-6 docs-card-col">
<div class="docs-card">
<div id="architecture-block" class="docs-card-heading">
<h4 class="">Foundations</h4>
</div>
<div class="docs-card-body">
<ul>
<li><a href="https://jupyter-client.readthedocs.io/en/latest/">Jupyter Client</a></li>
<li><a href="https://jupyter-core.readthedocs.io/en/latest/">Jupyter Core</a></li>
<li><a href="https://jupyter-alabaster-theme.readthedocs.io/en/latest/">Jupyter Alabaster Theme</a></li>
</ul>
</div>
</div>
</div>

</div>
</div>
</div>
</section>

0 comments on commit 242bc7c

Please sign in to comment.