https://github.com/waikato-datamining/docker-for-data-scientists

From one data scientist to another on how to utilize docker to make your life easier.
https://github.com/waikato-datamining/docker-for-data-scientists

data-science data-scientist docker

Last synced: 5 days ago
JSON representation

From one data scientist to another on how to utilize docker to make your life easier.

• Host: GitHub
• URL: https://github.com/waikato-datamining/docker-for-data-scientists
• Owner: waikato-datamining
• License: cc-by-sa-4.0
• Created: 2021-03-25T20:19:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-15T22:12:54.000Z (about 2 months ago)
• Last Synced: 2024-09-16T00:07:55.748Z (about 2 months ago)
• Topics: data-science, data-scientist, docker
• Homepage: https://www.data-mining.co.nz/docker-for-data-scientists/
• Size: 6.19 MB
• Stars: 1
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docker-for-data-scientists

From one data scientist to another on how to utilize docker to make your life easier.

You can view the auto-generated documentation here:

https://www.data-mining.co.nz/docker-for-data-scientists/

## Installation

Best approach is to install mkdocs in a virtual environment (`venv` directory):

* Python 3

  ```

  virtualenv -p /usr/bin/python3 venv

  ```

* Install mkdocs and dependencies

  ```

  ./venv/bin/pip install mkdocs==1.4.2 jinja2==3.1.2 "Markdown<3.4.0" mkdocs-material==8.5.10

  ```

## Content

In order for content to show up, it needs to be added to the configuration, 

i.e., in the `pages` section of the `mkdocs.yml` file.

Some pointers:

* [Images and media](http://www.mkdocs.org/user-guide/writing-your-docs/#images-and-media)

* [Linking](http://www.mkdocs.org/user-guide/writing-your-docs/#linking-documents)

* [mkdocs.yml](http://www.mkdocs.org/user-guide/configuration/)

## Build

[mkdocs](http://www.mkdocs.org/) is used to generate HTML from the 

markdown documents and images:

```

./venv/bin/mkdocs build --clean

```

## Testing

You can test what the site looks like, using the following command

and opening a browser on [localhost:8000](http://127.0.0.1:8000):

mkdocs monitors setup and markdown files, so you can just add and edit

them as you like, it will automatically rebuild and refresh the browser.

```

./venv/bin/mkdocs build --clean && ./venv/bin/mkdocs serve

```

## Deploying

Any push will trigger a rebuild of the site on github via github actions:

[.github/workflows/main.yml](.github/workflows/main.yml)