Merge pull request #59 from entelecheia/main

entelecheia · Feb 25, 2024 · edac7a7 · edac7a7
2 parents 1e5b614 + 1b513b8
commit edac7a7
Show file tree

Hide file tree

Showing 12 changed files with 155 additions and 138 deletions.
diff --git a/.copier-config.yaml b/.copier-config.yaml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; do NOT edit manually
-_commit: v0.11.12-8-g26f3aa4
+_commit: v0.11.13-13-gfdcc056
 _src_path: .
 author: Young Joon Lee
 build_and_release: true

diff --git a/.copier-template/.github/workflows/{% if build_and_release %}lint_and_test.yaml{% endif %} b/.copier-template/.github/workflows/{% if build_and_release %}lint_and_test.yaml{% endif %}
@@ -71,7 +71,8 @@ jobs:
           echo '\n\n\n'
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
+          token: ${{ secrets.CODECOV_TOKEN }} # required
           fail_ci_if_error: false # optional (default = false)
           verbose: true # optional (default = false)
diff --git a/.copier-template/.tasks.toml.jinja b/.copier-template/.tasks.toml.jinja
@@ -107,6 +107,15 @@ help = "build the book with all outputs"
 [tool.poe.tasks.book-publish]
 cmd = "ghp-import -n -p -f book/_build/html"
 help = "publish the book"
+{%- elif documentaion_tool == 'mkdocs' %}
+
+[tool.poe.tasks.build-docs]
+cmd = "mkdocs build -f mkdocs.yaml"
+help = "build documentation"
+
+[tool.poe.tasks.install-mkdocs]
+cmd = "pip install -r docs/requirements.txt"
+help = "install mkdocs"
 {%- endif %}
 
 [tool.poe.tasks.install]

diff --git a/.copier-template/{% if documentaion_tool == 'mkdocs' %}docs{% endif %}/index.md.jinja b/.copier-template/{% if documentaion_tool == 'mkdocs' %}docs{% endif %}/index.md.jinja
@@ -1,6 +1,8 @@
 {!README.md!}
 
+{% if build_and_release %}
 Check out the [usage](usage) section for further information.
+{% endif %}
 
 {% if project_name != 'hyperfast-python-template' %}
 !!! note

diff --git a/...kdocs' %}docs{% endif %}/requirements.txt → ... %}docs{% endif %}/requirements.txt.jinja b/...kdocs' %}docs{% endif %}/requirements.txt → ... %}docs{% endif %}/requirements.txt.jinja
@@ -1,7 +1,9 @@
 mkdocs
-mkdocstrings[python]
 markdown-include
 mkdocs-material
 mkdocs-material-extensions>=1.1
 pymdown-extensions>=9.9.1
+{%- if build_and_release %}
+mkdocstrings[python]
 mkdocs-click
+{%- endif %}
diff --git a/... %}docs{% endif %}/reference/cli.md.jinja → ...lease %}reference{% endif %}/cli.md.jinja b/... %}docs{% endif %}/reference/cli.md.jinja → ...lease %}reference{% endif %}/cli.md.jinja
diff --git a/...%}docs{% endif %}/reference/init.md.jinja → ...ease %}reference{% endif %}/init.md.jinja b/...%}docs{% endif %}/reference/init.md.jinja → ...ease %}reference{% endif %}/init.md.jinja
diff --git a/...ol == 'mkdocs' %}docs{% endif %}/usage.md → ...f build_and_release %}usage.md{% endif %} b/...ol == 'mkdocs' %}docs{% endif %}/usage.md → ...f build_and_release %}usage.md{% endif %}
diff --git a/.github/workflows/lint_and_test.yaml b/.github/workflows/lint_and_test.yaml
@@ -71,7 +71,8 @@ jobs:
           echo '\n\n\n'
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
+          token: ${{ secrets.CODECOV_TOKEN }} # required
           fail_ci_if_error: false # optional (default = false)
           verbose: true # optional (default = false)
diff --git a/poetry.lock b/poetry.lock
diff --git a/tmp/.copier-config.yaml b/tmp/.copier-config.yaml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; do NOT edit manually
-_commit: v0.11.12-7-g7c17e28
+_commit: v0.11.13-13-gd85056b
 _src_path: .
 author: Young Joon Lee
 build_and_release: true

diff --git a/tmp/.github/workflows/lint_and_test.yaml b/tmp/.github/workflows/lint_and_test.yaml
@@ -71,7 +71,8 @@ jobs:
           echo '\n\n\n'
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
+          token: ${{ secrets.CODECOV_TOKEN }} # required
           fail_ci_if_error: false # optional (default = false)
           verbose: true # optional (default = false)