https://github.com/cbw-dev/jupyterbook-docs

This repo will host the website that will be the documentation for making a CBW workshop using Jupyter Book.

https://github.com/cbw-dev/jupyterbook-docs

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.2%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

This repo will host the website that will be the documentation for making a CBW workshop using Jupyter Book.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago

https://github.com/cbw-dev/jupyterbook-docs/blob/main/

# CBW's Jupyter Book Documentation

This is the repo that hosts the CBW's Jupyter Book documentation website.

**Lots of more documentation has to be done: notes from Julia_LabNotes for JupyterBook are from pages 23-30**


DEV RULES:
- all links to the web should create a new tab for it: use html code:
```
Opens in new tab
```

Notes:
- when building the website for these docs, you're going to get a lot of warnings about headers, this is just because there are some non-consecutive headers, you can ignore

BUGS:
- Primary sidebar toggle button does not work well (the way it works defeats its point)
- To-do list markdown not formatting correctly


To-Do List
- EXPLAIN MERGE CONFLICTS
- FIND A BETTER WAY TO SHOW TABLES (schedule)

Suggestions:
- add timing of downloads/installations (VSCode, python, jupyter book)
- add code chunk option to the file setup explanation code chunk, so that this takes up the width of the entire page?
- add border (css styling) to instruction pictures
- best practices section ?

## Helpful Links
- [Docs](https://jupyterbook.org/en/stable/file-types/jupytext.html)
- [Docs GitHub, helpful code!](https://github.com/jupyter-book/jupyter-book/blob/main/docs/file-types/jupytext.Rmd)
- [Jupyter Book Gallery](https://executablebooks.org/en/latest/gallery/)
- [Sidebar toggle issue?](https://github.com/jupyter-book/jupyter-book/issues/2160)

Owner

  • Name: cbw-dev
  • Login: cbw-dev
  • Kind: organization

GitHub Events

Total
  • Member event: 1
  • Push event: 53
  • Create event: 2
Last Year
  • Member event: 1
  • Push event: 53
  • Create event: 2

Dependencies

requirements.txt pypi
  • jupyter-book *
  • matplotlib *
  • numpy *