Skip to content

Commit

Permalink
Legge til installasjon i README
Browse files Browse the repository at this point in the history
  • Loading branch information
patped committed Sep 26, 2024
1 parent b31bdb2 commit 0e8e143
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
site
.DS_Store
.venv
venv
.idea/
.dbtenv
.dbtenv
11 changes: 11 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
SHELL = /bin/bash
.DEFAULT_GOAL = install

PY = ./.venv/bin/python -m

.PHONY: install ## install requirements in virtual env
install:
rm -rf .venv
python3 -m venv .venv && \
${PY} pip install --upgrade pip && \
${PY} pip install -r requirements-doc.txt
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,27 @@ The documentation is hosted in [navikt.github.io/dbt-i-nav](https://navikt.githu

For full documentation visit [mkdocs.org](https://www.mkdocs.org) and [material](https://squidfunk.github.io/mkdocs-material/).

## Installation

### Requirements

* python v3

### macOS / Linux

```shell
make
```

### Windows

```shell
pip install -r requirements-doc.txt
```

## Commands

* `source .venv/bin/activate` - Activates venv on macOS / Linux
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
Expand Down
2 changes: 2 additions & 0 deletions requirements-doc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
mkdocs-material
mkdocs-git-revision-date-localized-plugin

0 comments on commit 0e8e143

Please sign in to comment.