Merge pull request #17 from melissawm/remove-sphinx

Removed sphinx and added binder

Author: rgommers

.github/workflows/chatops.yaml

@@ -0,0 +1,34 @@
+#./github/workflows/chatops.yaml
+name: Chatops
+on: [issue_comment] # issues and PRs are equivalent in terms of comments for the GitHub API
+
+jobs:
+  trigger-chatops:
+    # Make sure the comment is on a PR, and contains the command "/binder"
+    if: (github.event.issue.pull_request != null) &&  contains(github.event.comment.body, '/binder')
+    runs-on: ubuntu-latest
+    steps:
+      # Use the GitHub API to: 
+      #  (1) Get the branch name of the PR that has been commented on with "/binder" 
+      #  (2) make a comment on the PR with the binder badge
+    - name: comment on PR with Binder link
+      uses: actions/github-script@v1
+      with:
+        github-token: ${{secrets.GITHUB_TOKEN}}
+        script: |
+          // Get the branch name
+          github.pulls.get({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            pull_number: context.payload.issue.number
+          }).then( (pr) => {
+
+            // use the branch name to make a comment  on the PR with a Binder badge
+            var BRANCH_NAME = pr.data.head.ref
+            github.issues.createComment({
+              issue_number: context.payload.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/${context.repo.owner}/${context.repo.repo}/${BRANCH_NAME}) :point_left: Launch a binder notebook on this branch`
+            })
+          })

Makefile

@@ -1,17 +1,43 @@
 # NumPy tutorials
 
+[![Binder](http://mybinder.org/badge_logo.svg)](http://mybinder.org/v2/gh/numpy/numpy-tutorials/master/content)
+
 This set of tutorials and educational materials is being developed,
-IT IS NOT YET INTEGRATED IN THE HTML DOCS AT https://www.numpy.org/devdocs/
+IT IS NOT INTEGRATED IN THE HTML DOCS AT https://www.numpy.org/devdocs/
 
 The goal of this repository is to provide high-quality resources by the
-NumPy project, both for self-learning and for teaching classes with.
+NumPy project, both for self-learning and for teaching classes with. If you're
+interested in adding your own content, check the [Contributing](#contributing)
+section.
+
+To open a live version of the content, click the **launch Binder** button above.
+To download a local copy of the `.ipynb` files, you can either
+[clone this repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
+or navigate to any of the documents listed below and download it individually.
+
+## Content
+
+1. [Tutorial: Linear algebra on n-dimensional arrays](content/tutorial-svd.ipynb)
+2. [Tutorial: CS231n Python Tutorial With Google Colab](content/cs231_tutorial.ipynb)
 
 ## Contributing
 
 We very much welcome contributions! If you have an idea or proposal for a new
-tutorial, please open an issue with an outline.
+tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues)
+with an outline. After you have decided on a topic and approach, submit your
+notebook file via a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
+For more information about GitHub and its workflow, you can see
+[this document](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests).
 
-## Jupyter Notebooks
+Don’t worry if English is not your first language, or if you can only come up
+with a rough draft. Open source is a community effort. Do your best – we’ll help
+fix issues.
+
+Images and real-life data make text more engaging and powerful, but be sure what
+you use is appropriately licensed and available. Here again, even a rough idea
+for artwork can be polished by others.
+
+### Why Jupyter Notebooks?
 
 The choice of Jupyter Notebook in this repo instead of the usual format 
 ([reStructuredText, through Sphinx](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html))
@@ -22,44 +48,22 @@ used in the main NumPy documentation has two reasons:
  * rST may present a barrier for some people who might otherwise be very
    interested in contributing tutorial material.
 
-## Generating the "site"
-
-Sphinx is configured with the appropriate extensions to execute the notebooks
-and generated webpages from them. To accomplish this from a fresh repo:
+### Adding your own tutorials
 
-1. Install the dependencies: from a terminal, run
-   
-   ```
-   pip install -r requirements.txt
-   ```
-
-   To execute the notebooks, you'll also need to install the dependencies for
-   the tutorial(s) themselves:
-
-   ```
-   pip install -r content/requirements.txt
-   ```
-
-2. Build and view: from your terminal, run
-
-   ```
-   make html && <your_browser> _build/html/index.html
-   ```
-
-## Adding your own tutorials
-
-If you have your own tutorial in the form of a Jupyter notebook and you'd like
+If you have your own tutorial in the form of a Jupyter notebook (a `.ipynb`
+file) and you'd like
 to try it out on the site:
 
 1. Add your notebook to the `content/` directory
-2. Update `content/requirements.txt` with the dependencies for your tutorial
-3. Update the `toctree` in `index.rst` to include your new entry
-4. Update the attribution section (below) to credit the original tutorial 
-   author.
+2. Update the `environment.yml` file with the dependencies for your tutorial
+(only if you add new dependencies)
+3. Update this `README.md` to include your new entry
+4. Update the attribution section (below) to credit the original tutorial
+author.
 
-## Attribution
+### Attribution
 
- - The [cs231n][cs231] tutorial is by [@jcjohnson][jj]. The full tutorial in 
+ - The cs231n tutorial is by [@jcjohnson][jj]. The full tutorial in 
    its original form is linked via [numpy.org][learn].
  - The SVD tutorial is by [@melissawm][mwm]. The full tutorial is available
    via the [tutorials page][np_tutorials] of the official NumPy documentation.
@@ -68,14 +72,17 @@ to try it out on the site:
 [mwm]: https://github.com/melissawm
 [np_tutorials]: https://numpy.org/devdocs/user/tutorials_index.html
 
-## Useful links
+## Useful links and resources
 
-The following may be useful:
+The following links may be useful:
 
-- [NumPy documentation team meetings](https://hackmd.io/oB_boakvRqKR-_2jRV-Qjg?both)
+- [NumPy Code of Conduct](https://numpy.org/doc/stable/dev/conduct/code_of_conduct.html)
+- [Main NumPy documentation](https://numpy.org/doc/stable/)
+- [NumPy documentation team meeting notes](https://hackmd.io/oB_boakvRqKR-_2jRV-Qjg?both)
 - [NEP 44 - Restructuring the NumPy documentation](https://numpy.org/neps/nep-0044-restructuring-numpy-docs.html)
 - [Blog post - Documentation as a way to build Community](https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community/)
-- Note that regular documentation issues for NumPy can be found in the
-  [main NumPy repository](https://github.com/numpy/numpy/issues) (see the
-  `Documentation` labels (2x) there)
+
+Note that regular documentation issues for NumPy can be found in the [main NumPy
+repository](https://github.com/numpy/numpy/issues) (see the `Documentation`
+labels there). 
 

README.md

@@ -0,0 +1,7 @@
+name: numpy-tutorials
+channels:
+  - conda-forge
+dependencies:
+  - numpy
+  - scipy
+  - matplotlib