Skip to content

Commit

Permalink
jupyter-books 0.7.3 no longer supports 'headers'. (#363)
Browse files Browse the repository at this point in the history
* jupyter-books 0.7.3 no longer supports 'headers'.

* Update GitHub README to reflect the focus on tutorials.

* Tweak sizes and port to setup.py.

* Drop test_0090 in light of #350 and the fact that it's now broken.
  • Loading branch information
jpivarski committed Jul 31, 2020
1 parent 38e4d81 commit 141aead
Show file tree
Hide file tree
Showing 17 changed files with 36 additions and 523 deletions.
24 changes: 7 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,13 @@ Arrays are **dynamically typed**, but operations on them are **compiled and fast

<table>
<tr>
<td width="33%" valign="top">
<a href="https://awkward-array.org/how-to.html">
<img src="docs-img/panel-data-analysts.png" width="268">
</a>
<p align="center"><b>
<a href="https://awkward-array.org/how-to.html">
How-to documentation<br>for data analysts
</a>
</b></p>
</td>
<td width="33%" valign="top">
<a href="https://awkward-array.org/how-it-works.html">
<img src="docs-img/panel-developers.png" width="268">
<td width="66%" valign="top">
<a href="https://awkward-array.org">
<img src="docs-img/panel-tutorials.png" width="570">
</a>
<p align="center"><b>
<a href="https://awkward-array.org/how-it-works.html">
How-it-works tutorials<br>for developers
<a href="https://awkward-array.org">
How-to tutorials
</a>
</b></p>
</td>
Expand All @@ -39,15 +29,15 @@ Arrays are **dynamically typed**, but operations on them are **compiled and fast
</a>
<p align="center"><b>
<a href="https://awkward-array.readthedocs.io/en/latest/index.html">
Python<br>API reference
Python API reference
</a>
</b></p>
<a href="https://awkward-array.readthedocs.io/en/latest/_static/index.html">
<img src="docs-img/panel-doxygen.png" width="268">
</a>
<p align="center"><b>
<a href="https://awkward-array.readthedocs.io/en/latest/_static/index.html">
C++<br>API reference
C++ API reference
</a>
</b></p>
</td>
Expand Down
Binary file added docs-img/panel-tutorials-alternate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-img/panel-tutorials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 2 additions & 30 deletions docs-src/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
- file: what-is-awkward
title: "What is an Awkward Array?"

- header: "How-to tutorials"

- file: how-to
title: "Introduction"

- file: how-to-convert
title: "Converting arrays"
expand_sections: true
Expand Down Expand Up @@ -38,8 +33,8 @@
title: "ArrayBuilder (easy & general)"
- file: how-to-create-layout
title: "Layout (faster)"
- file: how-to-create-lazy-dask
title: "Lazy arrays and Dask"
- file: how-to-create-lazy
title: "Lazy arrays"

- file: how-to-use-in-numba
title: "Using arrays in Numba"
Expand Down Expand Up @@ -135,26 +130,3 @@
title: "In Numba"
- file: how-to-specialize-lorentz
title: "For physics: Lorentz vectors"

- header: "How-it-works tutorials"

- file: how-it-works
title: "Introduction"

- file: articles-data-types
title: "Abstract data types"

- file: articles-layouts
title: "Columnar layouts"

- file: articles-arrays-are-functions
title: "Arrays as functional programming"

- file: articles-vectorization
title: "Slow control and fast math"

- file: articles-arraybuilder
title: "Record-oriented → columnar"

- file: articles-identities
title: "Array element identities"
23 changes: 0 additions & 23 deletions docs-src/articles-arraybuilder.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs-src/articles-arrays-are-functions.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs-src/articles-data-types.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs-src/articles-identities.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs-src/articles-vectorization.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs-src/how-it-works.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs-src/how-to-create-lazy-dask.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ kernelspec:
name: python3
---

Columnar layouts
================
How to create lazy arrays
=========================

**This is a stub:** I intend to write this article, but haven't yet.

Expand Down
2 changes: 1 addition & 1 deletion docs-src/how-to-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Creating arrays

* **[ArrayBuilder (easy & general)](how-to-create-arraybuilder)**
* **[Layout (faster)](how-to-create-layout)**
* **[Lazy arrays and Dask](how-to-create-lazy-dask)**
* **[Lazy arrays](how-to-create-lazy)**
37 changes: 0 additions & 37 deletions docs-src/how-to.md

This file was deleted.

26 changes: 3 additions & 23 deletions docs-src/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Arrays are **dynamically typed**, but operations on them are **compiled and fast
Quickstart
==========

Use the panel on the left for tutorials, click below for reference documentation, or [here for GitHub](https://github.com/scikit-hep/awkward-1.0).

<table style="margin-top: 30px">
<tr>
<td width="50%" valign="top" align="center">
Expand All @@ -43,28 +45,6 @@ Quickstart
</b></p>
</td>
</tr>
<tr style="margin-top: 20px">
<td width="50%" valign="top" align="center">
<a href="how-to.html">
<img src="https://github.com/scikit-hep/awkward-1.0/raw/master/docs-img/panel-data-analysts.png" width="80%">
</a>
<p align="center" style="margin-top: 10px"><b>
<a href="how-to.html">
How-to documentation<br>for data analysts
</a>
</b></p>
</td>
<td width="50%" valign="top" align="center">
<a href="how-it-works.html">
<img src="https://github.com/scikit-hep/awkward-1.0/raw/master/docs-img/panel-developers.png" width="80%">
</a>
<p align="center" style="margin-top: 10px"><b>
<a href="how-it-works.html">
How-it-works tutorials<br>for developers
</a>
</b></p>
</td>
</tr>
</table>

Installation
Expand All @@ -81,7 +61,7 @@ Most users will get a precompiled binary (wheel) for your operating system and P
Getting help
------------

Report bugs, request features, and ask for additional documentation on [GitHub Issues](https://github.com/scikit-hep/awkward-1.0/issues). If you have a general "How do I…?" question, we'll answer it as a new [example in the tutorial](how-to).
Report bugs, request features, and ask for additional documentation on [GitHub Issues](https://github.com/scikit-hep/awkward-1.0/issues). If you have a general "How do I…?" question, we'll answer it as a new example on this site.

If you have a problem that's too specific to be new documentation or it isn't exclusively related to Awkward Array, it might be more appropriate to ask on [StackOverflow with the [awkward-array] tag](https://stackoverflow.com/questions/tagged/awkward-array). Be sure to include tags for any other libraries that you use, such as Pandas or PyTorch.

Expand Down
Loading

0 comments on commit 141aead

Please sign in to comment.