Skip to content

Commit 2e9d47d

Browse files
author
Francesco Calcavecchia
committed
fix technical issues
1 parent 6c626e8 commit 2e9d47d

File tree

3 files changed

+25
-30
lines changed

3 files changed

+25
-30
lines changed

.pre-commit-config.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,5 @@ repos:
2424
- id: mdformat
2525
args: ["--wrap", "120"]
2626
additional_dependencies:
27-
- mdformat-admon
2827
- mdformat-mkdocs
2928
- mdformat-tables

docs/index.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,26 @@ Data as Code (DaC) is a paradigm of distributing versioned data as versioned cod
88

99
!!! warning "Disclaimer"
1010

11-
```
12-
Currently the focus is on tabular and batch data, and Python code only.
11+
Currently the focus is on tabular and batch data, and Python code only.
1312

14-
Future extensions may be possible, depending on the community interest.
15-
```
13+
Future extensions may be possible, depending on the community interest.
1614

1715
## Consumer - Data Scientist
1816

1917
??? info "Follow along"
2018

21-
````
22-
The code snippets below can be executed on your machine too!
23-
You just need to configure `pip` to point to the pypi registry where we stored the example DaC package. You can do this by running
19+
The code snippets below can be executed on your machine too! You just need to configure `pip` to point to the pypi
20+
registry where we stored the example DaC package. You can do this by running
2421

25-
```shell
26-
❯ export PIP_EXTRA_INDEX_URL=https://gitlab.com/api/v4/projects/43746775/packages/pypi/simple
27-
```
22+
```shell
23+
❯ export PIP_EXTRA_INDEX_URL=https://gitlab.com/api/v4/projects/43746775/packages/pypi/simple
24+
```
2825

29-
Of course don't forget to create an isolated environment before using `pip` to install the package:
26+
Of course don't forget to create an isolated environment before using `pip` to install the package:
3027

31-
```shell
32-
❯ python -m venv venv && . venv/bin/activate
33-
```
34-
````
28+
```shell
29+
❯ python -m venv venv && . venv/bin/activate
30+
```
3531

3632
Say that the Data Engineers prepared the DaC `dac-example-energy` for you. Install it with
3733

@@ -159,9 +155,8 @@ In this case [`pandera`](https://pandera.readthedocs.io/en/stable/index.html) ha
159155

160156
!!! hint "Example data does not look right"
161157

162-
```
163-
The example data above does not look right. Does this mean that there is something wrong in the implementation of the `example` method? Not really! Read [here](#nice-to-have-schemaexample-method).
164-
```
158+
The example data above does not look right. Does this mean that there is something wrong in the implementation of the
159+
`example` method? Not really! Read [here](#nice-to-have-schemaexample-method).
165160

166161
## Producer - Data Engineer
167162

@@ -172,9 +167,9 @@ but are not strictly necessary.
172167

173168
!!! hint "Use [`pandera`](https://pandera.readthedocs.io/en/stable/index.html) to define the Schema"
174169

175-
```
176-
If the dataframe engine (pandas/polars/dask/spark...) you are using is supported by [`pandera`](https://pandera.readthedocs.io/en/stable/index.html), consider using a [`DataFrameModel`](https://pandera.readthedocs.io/en/stable/dataframe_models.html) to define the Schema.
177-
```
170+
If the dataframe engine (pandas/polars/dask/spark...) you are using is supported by
171+
[`pandera`](https://pandera.readthedocs.io/en/stable/index.html), consider using a
172+
[`DataFrameModel`](https://pandera.readthedocs.io/en/stable/dataframe_models.html) to define the Schema.
178173

179174
### Write the library
180175

mkdocs.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
site_name: Data as Code
22

3-
repo_url: https://github.com/data-as-code/dac
4-
edit_uri: tree/main/doc
3+
repo_url: https://github.com/data-as-code/docs
4+
edit_uri: edit/main/docs/
55

66
nav:
77
- Home: index.md
88

99
theme:
1010
name: material
1111
features:
12+
- content.action.edit
1213
- content.code.annotate
1314
- content.code.copy
1415
- navigation.instant
1516
- navigation.tracking
1617
- toc.follow
18+
icon:
19+
edit: material/pencil
20+
view: material/eye
1721

1822
plugins:
1923
- search
@@ -26,18 +30,15 @@ markdown_extensions:
2630
- pymdownx.inlinehilite
2731
- pymdownx.superfences
2832
- pymdownx.emoji:
29-
emoji_index: !!python/name:material.extensions.emoji.twemoji # noqa
30-
31-
32-
emoji_generator: !!python/name:material.extensions.emoji.to_svg # noqa
33+
emoji_index: !!python/name:material.extensions.emoji.twemoji
3334

35+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
3436

3537
- pymdownx.superfences:
3638
custom_fences:
3739
- name: mermaid
3840
class: mermaid
39-
format: !!python/name:pymdownx.superfences.fence_code_format # noqa
40-
41+
format: !!python/name:pymdownx.superfences.fence_code_format
4142

4243
- tables
4344
- toc:

0 commit comments

Comments
 (0)