Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ajparsons committed Aug 21, 2024
1 parent d130a38 commit 26861c9
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions data-repo-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This currently contains two templates.
- `src/data_common` - submodule for the `data_common` repo that contains common tools and helper libraries.
- `src/[repo_name]` - where you should put specific python scripts for this repository.
- `tests` - directory for pytest tests.
- `Dockerfile.dev` - The Dockerfile for this repo. Is locked to the `data_common` image at the latest commit when the repo was upgraded. This can be updated if you make changes that require a new docker setup.
- `Dockerfile` - The Dockerfile for this repo. Is locked to the `data_common` image at the latest commit when the repo was upgraded. This can be updated if you make changes that require a new docker setup.

# Code formatting and conventions

Expand Down Expand Up @@ -200,10 +200,6 @@ from data_common.notebook import *

This will load common libraries like Pandas, Altair, and numpy, as well as the mySociety customisation of these. It will also set the current working directory to the root of the project.

### Binder

[Binder](https://mybinder.org/) is a tool for demoing and using jupyter notebooks online. Binder links are automatically generated for the repo using the cookiecutter template. This will only work with repos that do not require secrets (these can not safely be loaded into binder).

# Rendering

Render setings are defined in a top-level `render.yaml`. This indicates how notebooks should be grouped into a single `document`. Parameters, the title and the slug (used to define folder structure) can use jinja templating to define their values dynamically.
Expand Down

0 comments on commit 26861c9

Please sign in to comment.