Skip to content

Commit 53209b5

Browse files
pwwangpwwang
committed
chore(docs): add mkdocs and related dependencies for documentation generation
1 parent ee5c86f commit 53209b5

File tree

4 files changed

+2997
-160
lines changed

4 files changed

+2997
-160
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ jobs:
1919
run: |
2020
python -m pip install poetry
2121
poetry config virtualenvs.create false
22+
poetry install -v --with docs
2223
python -m pip install --upgrade pip
2324
# Can't skip optional deps with poetry install -v
2425
# poetry install -v
2526
python -m pip install .
2627
- name: Build docs
2728
run: |
28-
python -m pip install -r docs/requirements.txt
29+
# python -m pip install -r docs/requirements.txt
2930
python -m ipykernel install --user --name python --display-name python
3031
python -m ipykernel install --user --name python3 --display-name python3
3132
cd docs

‎mkdocs.yml‎

Lines changed: 78 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ theme:
3030
markdown_extensions:
3131
- markdown.extensions.admonition
3232
- pymdownx.emoji:
33-
emoji_index: !!python/name:materialx.emoji.twemoji
34-
emoji_generator: !!python/name:materialx.emoji.to_svg
33+
emoji_index: !!python/name:material.extensions.emoji.twemoji
34+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
3535
- pymdownx.superfences:
3636
preserve_tabs: true
3737
- toc:
@@ -46,87 +46,87 @@ extra_css:
4646
nav:
4747
- 'Home': 'index.md'
4848
- 'Reference maps':
49-
'ALL': 'reference-maps/ALL.md'
50-
'base': 'reference-maps/base.md'
51-
'dplyr': 'reference-maps/dplyr.md'
52-
'tibble': 'reference-maps/tibble.md'
53-
'tidyr': 'reference-maps/tidyr.md'
54-
'forcats': 'reference-maps/forcats.md'
55-
'data': 'reference-maps/datasets.md'
56-
'other': 'reference-maps/other.md'
49+
- 'reference-maps/ALL.md'
50+
- 'reference-maps/base.md'
51+
- 'reference-maps/dplyr.md'
52+
- 'reference-maps/tibble.md'
53+
- 'reference-maps/tidyr.md'
54+
- 'reference-maps/forcats.md'
55+
- 'reference-maps/datasets.md'
56+
- 'reference-maps/other.md'
5757
- 'Import datar': 'import.md'
5858
- 'Backends': 'backends.md'
5959
- 'Options': 'options.md'
6060
- 'The f-expression': 'f.md'
6161
- 'Data': 'data.md'
6262
- 'Examples':
63-
'across': 'notebooks/across.ipynb'
64-
'add_column': 'notebooks/add_column.ipynb'
65-
'add_row': 'notebooks/add_row.ipynb'
66-
'arrange': 'notebooks/arrange.ipynb'
67-
'base': 'notebooks/base.ipynb'
68-
'base-arithmetic': 'notebooks/base-arithmetic.ipynb'
69-
'base-funs': 'notebooks/base-funs.ipynb'
70-
'between': 'notebooks/between.ipynb'
71-
'bind': 'notebooks/bind.ipynb'
72-
'case_when': 'notebooks/case_when.ipynb'
73-
'chop': 'notebooks/chop.ipynb'
74-
'coalesce': 'notebooks/coalesce.ipynb'
75-
'complete': 'notebooks/complete.ipynb'
76-
'context': 'notebooks/context.ipynb'
77-
'count': 'notebooks/count.ipynb'
78-
'cumall': 'notebooks/cumall.ipynb'
79-
'desc': 'notebooks/desc.ipynb'
80-
'distinct': 'notebooks/distinct.ipynb'
81-
'drop_na': 'notebooks/drop_na.ipynb'
82-
'enframe': 'notebooks/enframe.ipynb'
83-
'expand': 'notebooks/expand.ipynb'
84-
'expand_grid': 'notebooks/expand_grid.ipynb'
85-
'extract': 'notebooks/extract.ipynb'
86-
'fill': 'notebooks/fill.ipynb'
87-
'filter': 'notebooks/filter.ipynb'
88-
'filter-joins': 'notebooks/filter-joins.ipynb'
89-
'forcats_fct_multi': 'notebooks/forcats_fct_multi.ipynb'
90-
'forcats_lvl_addrm': 'notebooks/forcats_lvl_addrm.ipynb'
91-
'forcats_lvl_order': 'notebooks/forcats_lvl_order.ipynb'
92-
'forcats_lvl_value': 'notebooks/forcats_lvl_value.ipynb'
93-
'forcats_misc': 'notebooks/forcats_misc.ipynb'
94-
'full_seq': 'notebooks/full_seq.ipynb'
95-
'other': 'notebooks/other.ipynb'
96-
'group_by': 'notebooks/group_by.ipynb'
97-
'group_map': 'notebooks/group_map.ipynb'
98-
'group_split': 'notebooks/group_split.ipynb'
99-
'group_trim': 'notebooks/group_trim.ipynb'
100-
'lead-lag': 'notebooks/lead-lag.ipynb'
101-
'mutate-joins': 'notebooks/mutate-joins.ipynb'
102-
'mutate': 'notebooks/mutate.ipynb'
103-
'n_distinct': 'notebooks/n_distinct.ipynb'
104-
'na_if': 'notebooks/na_if.ipynb'
105-
'near': 'notebooks/near.ipynb'
106-
'nest': 'notebooks/nest.ipynb'
107-
'nest-join': 'notebooks/nest-join.ipynb'
108-
'nth': 'notebooks/nth.ipynb'
109-
'pack': 'notebooks/pack.ipynb'
110-
'pivot_longer': 'notebooks/pivot_longer.ipynb'
111-
'pivot_wider': 'notebooks/pivot_wider.ipynb'
112-
'pull': 'notebooks/pull.ipynb'
113-
'ranking': 'notebooks/ranking.ipynb'
114-
'readme': 'notebooks/readme.ipynb'
115-
'recode': 'notebooks/recode.ipynb'
116-
'relocate': 'notebooks/relocate.ipynb'
117-
'rename': 'notebooks/rename.ipynb'
118-
'replace_na': 'notebooks/replace_na.ipynb'
119-
'rownames': 'notebooks/rownames.ipynb'
120-
'rows': 'notebooks/rows.ipynb'
121-
'rowwise': 'notebooks/rowwise.ipynb'
122-
'select': 'notebooks/select.ipynb'
123-
'separate': 'notebooks/separate.ipynb'
124-
'setops': 'notebooks/setops.ipynb'
125-
'slice': 'notebooks/slice.ipynb'
126-
'summarise': 'notebooks/summarise.ipynb'
127-
'tibble': 'notebooks/tibble.ipynb'
128-
'uncount': 'notebooks/uncount.ipynb'
129-
'unite': 'notebooks/unite.ipynb'
130-
'with_groups': 'notebooks/with_groups.ipynb'
63+
- 'across': 'notebooks/across.ipynb'
64+
- 'add_column': 'notebooks/add_column.ipynb'
65+
- 'add_row': 'notebooks/add_row.ipynb'
66+
- 'arrange': 'notebooks/arrange.ipynb'
67+
- 'base': 'notebooks/base.ipynb'
68+
- 'base-arithmetic': 'notebooks/base-arithmetic.ipynb'
69+
- 'base-funs': 'notebooks/base-funs.ipynb'
70+
- 'between': 'notebooks/between.ipynb'
71+
- 'bind': 'notebooks/bind.ipynb'
72+
- 'case_when': 'notebooks/case_when.ipynb'
73+
- 'chop': 'notebooks/chop.ipynb'
74+
- 'coalesce': 'notebooks/coalesce.ipynb'
75+
- 'complete': 'notebooks/complete.ipynb'
76+
- 'context': 'notebooks/context.ipynb'
77+
- 'count': 'notebooks/count.ipynb'
78+
- 'cumall': 'notebooks/cumall.ipynb'
79+
- 'desc': 'notebooks/desc.ipynb'
80+
- 'distinct': 'notebooks/distinct.ipynb'
81+
- 'drop_na': 'notebooks/drop_na.ipynb'
82+
- 'enframe': 'notebooks/enframe.ipynb'
83+
- 'expand': 'notebooks/expand.ipynb'
84+
- 'expand_grid': 'notebooks/expand_grid.ipynb'
85+
- 'extract': 'notebooks/extract.ipynb'
86+
- 'fill': 'notebooks/fill.ipynb'
87+
- 'filter': 'notebooks/filter.ipynb'
88+
- 'filter-joins': 'notebooks/filter-joins.ipynb'
89+
- 'forcats_fct_multi': 'notebooks/forcats_fct_multi.ipynb'
90+
- 'forcats_lvl_addrm': 'notebooks/forcats_lvl_addrm.ipynb'
91+
- 'forcats_lvl_order': 'notebooks/forcats_lvl_order.ipynb'
92+
- 'forcats_lvl_value': 'notebooks/forcats_lvl_value.ipynb'
93+
- 'forcats_misc': 'notebooks/forcats_misc.ipynb'
94+
- 'full_seq': 'notebooks/full_seq.ipynb'
95+
- 'other': 'notebooks/other.ipynb'
96+
- 'group_by': 'notebooks/group_by.ipynb'
97+
- 'group_map': 'notebooks/group_map.ipynb'
98+
- 'group_split': 'notebooks/group_split.ipynb'
99+
- 'group_trim': 'notebooks/group_trim.ipynb'
100+
- 'lead-lag': 'notebooks/lead-lag.ipynb'
101+
- 'mutate-joins': 'notebooks/mutate-joins.ipynb'
102+
- 'mutate': 'notebooks/mutate.ipynb'
103+
- 'n_distinct': 'notebooks/n_distinct.ipynb'
104+
- 'na_if': 'notebooks/na_if.ipynb'
105+
- 'near': 'notebooks/near.ipynb'
106+
- 'nest': 'notebooks/nest.ipynb'
107+
- 'nest-join': 'notebooks/nest-join.ipynb'
108+
- 'nth': 'notebooks/nth.ipynb'
109+
- 'pack': 'notebooks/pack.ipynb'
110+
- 'pivot_longer': 'notebooks/pivot_longer.ipynb'
111+
- 'pivot_wider': 'notebooks/pivot_wider.ipynb'
112+
- 'pull': 'notebooks/pull.ipynb'
113+
- 'ranking': 'notebooks/ranking.ipynb'
114+
- 'readme': 'notebooks/readme.ipynb'
115+
- 'recode': 'notebooks/recode.ipynb'
116+
- 'relocate': 'notebooks/relocate.ipynb'
117+
- 'rename': 'notebooks/rename.ipynb'
118+
- 'replace_na': 'notebooks/replace_na.ipynb'
119+
- 'rownames': 'notebooks/rownames.ipynb'
120+
- 'rows': 'notebooks/rows.ipynb'
121+
- 'rowwise': 'notebooks/rowwise.ipynb'
122+
- 'select': 'notebooks/select.ipynb'
123+
- 'separate': 'notebooks/separate.ipynb'
124+
- 'setops': 'notebooks/setops.ipynb'
125+
- 'slice': 'notebooks/slice.ipynb'
126+
- 'summarise': 'notebooks/summarise.ipynb'
127+
- 'tibble': 'notebooks/tibble.ipynb'
128+
- 'uncount': 'notebooks/uncount.ipynb'
129+
- 'unite': 'notebooks/unite.ipynb'
130+
- 'with_groups': 'notebooks/with_groups.ipynb'
131131
- 'API': 'mkapi/api/datar'
132132
- 'Change Log': CHANGELOG.md

0 commit comments

Comments
 (0)