Skip to content

Commit

Permalink
answer questions
Browse files Browse the repository at this point in the history
  • Loading branch information
brownsarahm committed Feb 16, 2024
1 parent 4d569b1 commit 2d97322
Showing 1 changed file with 41 additions and 3 deletions.
44 changes: 41 additions & 3 deletions notes/2024-02-15.md
Original file line number Diff line number Diff line change
Expand Up @@ -1071,6 +1071,44 @@ Link to your tinybook repo. in the experience report PR

## Questions After Today's Class

```{important}
Will be added later, pulled from experience reflections
```
### Can you create a new remote through the terminal without using the github ui?

If you knew the URL of the remote, yes, if the remote is on GitHub, you have to use either github.com in your browser or use the `gh cli` tool's command [`gh repo create`](https://cli.github.com/manual/gh_repo_create)

### How is jupyterbook different than other ides or editors?

`jupyter-book` is not an editor or IDE, it is a tool for building websites or pdfs.

Jupyter Notebook is a single stream of computational analysis. Jupyter Lab is a more IDE like interface for doing compuational analyses. Both are part of [project jupyter](https://jupyter.org/) and [on GitHub](https://github.com/jupyter)

[Jupyter book](https://jupyterbook.org/en/stable/intro.html) is for publishing book like documents as websites and to other forms designed to be compatible with jupyter notebooks, but is a part of a separate [executable books](https://github.com/executablebooks) project. It is specialized for cases where there is computation in the code. See [their gallery]() for examples. I use it for [CSC310 that has code and plots in the notes](https://rhodyprog4ds.github.io/BrownFall22/notes/2022-09-21.html)

[Jupyter-book is an opinionated distribution](https://jupyterbook.org/en/stable/explain/sphinx.html#:~:text=opinionated%20distribution%20of%20Sphinx) of [sphinx](https://www.sphinx-doc.org/) which can also be used to document other languages like [C++](https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/)

### What is the .doctrees/ folder inside _build/ with files like environment.pickle?

That is an intermediate step between the markdown and the final HTML.

There is [api level docs](https://www.sphinx-doc.org/en/master/extdev/nodes.html)

### Why is building necessary? Couldn't it just be a part of compiling?


Building is a more general process of transforming from source to an output format. Compling is a specific step withing building for some programming languages. We will learn more about the build process for C later.

What we did today was building, but not compiling.

### What other uses are there for jupyter notebook

The course website is an example. They also maintain a [gallery of jupyter books](https://executablebooks.org/en/latest/gallery/)

### Did we create a repo locally?

yes `git init .` created a repo locally

### How to add more files and sections to your Jupyter Books website


Create more files in the folder and then update the `_toc.yml`. For example, this whole website is jupyter book, see how many files are in the [repo](https://github.com/compsys-progtools/spring2024/)


0 comments on commit 2d97322

Please sign in to comment.