Skip to content

Commit 8f64006

Browse files
author
a.pirogov
committed
fix: update deps and resolve problems and warnings with doc building
1 parent 1725595 commit 8f64006

6 files changed

Lines changed: 893 additions & 801 deletions

File tree

cookiecutter.json

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22
"__org_name": "Your Institution Inc.",
33
"__org_mail_suffix": "your-institution.org",
44
"__org_rep": "Your Boss <your.boss@{{ cookiecutter.__org_mail_suffix }}>",
5-
"__org_gh": "Github-Organization-Or-Username",
6-
"__org_gh_url": "https://github.com/{{ cookiecutter.__org_gh }}",
7-
"__org_homepage": "{{ cookiecutter.__org_gh_url }}",
5+
"__org_homepage": "https://organization.org",
86

97
"project_name": "FAIR Python App",
10-
"project_gh_org": "{{ cookiecutter.__org_gh }}",
11-
128
"__project_slug": "{{ cookiecutter.project_name | slugify() }}",
139
"__project_package": "{{ cookiecutter.project_name | slugify(separator='_') }}",
1410

15-
"__project_gh_name": "{{ cookiecutter.project_gh_org }}/{{ cookiecutter.__project_slug }}",
11+
"__org_gh": "Github-Organization-Or-Username",
12+
"__org_gh_url": "https://github.com/{{ cookiecutter.__org_gh }}",
13+
"__project_gh_org": "{{ cookiecutter.__org_gh }}",
14+
"__project_gh_name": "{{ cookiecutter.__project_gh_org }}/{{ cookiecutter.__project_slug }}",
1615
"__project_gh_repo": "https://github.com/{{ cookiecutter.__project_gh_name }}",
17-
"__project_gh_pages": "https://{{ cookiecutter.project_gh_org|lower }}.github.io/{{ cookiecutter.__project_slug }}",
16+
"__project_gh_pages": "https://{{ cookiecutter.__project_gh_org|lower }}.github.io/{{ cookiecutter.__project_slug }}",
1817

1918
"project_version": "0.1.0",
2019
"project_description": "TODO - A meaningful one-sentence description.",

mkdocs.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# basic configuration:
22
site_name: "fair-python-cookiecutter"
33
site_description: "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata."
4+
repo_name: "Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
5+
46
site_url: "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter"
57
repo_url: "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
6-
edit_uri: "blob/main/docs/"
7-
repo_name: "Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
8+
edit_uri: "edit/main/docs/"
9+
810
docs_dir: "{{ cookiecutter.__project_slug }}/docs"
911
watch: ["README.md"]
1012

@@ -110,8 +112,8 @@ markdown_extensions:
110112
check_paths: true
111113
# Icons and Emoji: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
112114
- pymdownx.emoji:
113-
emoji_index: !!python/name:materialx.emoji.twemoji
114-
emoji_generator: !!python/name:materialx.emoji.to_svg
115+
emoji_index: !!python/name:material.extensions.emoji.twemoji
116+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
115117

116118
plugins:
117119
# default search box (must be listed if plugins are added)

0 commit comments

Comments
 (0)