doc: pdoc target outputs to local path, add earthlyignore

input-output-hk · Aug 22, 2023 · 58648f4 · 58648f4
1 parent 58047df
commit 58648f4
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 12 deletions.
diff --git a/services/voting-node/.earthlyignore b/services/voting-node/.earthlyignore
@@ -0,0 +1,6 @@
+*egg-info/
+build/
+dist/
+__pycache__/
+.ruff-cache/
+doc/
diff --git a/services/voting-node/.gitignore b/services/voting-node/.gitignore
@@ -1,3 +1,4 @@
 tempo-data/
 *egg-info/
 build/
+doc/
diff --git a/services/voting-node/Earthfile b/services/voting-node/Earthfile
@@ -42,7 +42,7 @@ install-deps:
     RUN poetry install --only main --no-root
 
     # Copy the voting_node source code
-    COPY --dir voting_node development.md ./
+    COPY --dir voting_node readme.md ./
 
     SAVE ARTIFACT .venv .venv
     SAVE IMAGE --cache-hint
@@ -70,8 +70,8 @@ pytest:
 
 pdoc:
     FROM +build-dev
-    RUN poetry run pdoc -o /apidoc ./voting_node
-    SAVE ARTIFACT /apidoc doc
+    RUN poetry run pdoc -o /doc ./voting_node
+    SAVE ARTIFACT /doc AS LOCAL ./doc
 
 docker:
     FROM python:3.11-slim-bullseye
@@ -92,25 +92,25 @@ docker:
     RUN apt-get clean && \
         rm -rf /var/lib/apt/lists/*
 
+    # Copy the rest of the application code to the container
+    COPY ../../src/jormungandr/jormungandr+build/jormungandr /app/jormungandr
+    COPY ../../src/jormungandr/jcli+build/jcli /app/jcli
+    COPY ../../src/catalyst-toolbox/catalyst-toolbox+build/catalyst-toolbox /app/catalyst-toolbox
+    COPY ../../src/voting-tools-rs+build/snapshot_tool /app/snapshot_tool
+
     # Set the working directory
     WORKDIR /app
 
     # Copy the distribution wheels from the build stage
     COPY +build/wheels /app
     COPY +build/requirements.txt /app
     COPY ../../utilities/ideascale-importer+build/src /src/utilities/ideascale-importer
-    COPY entry.sh /app
-    RUN chmod +x /app/entry.sh
-
     # Install the package
     RUN pip3 install --no-cache -r requirements.txt
     RUN pip3 install --no-cache *.whl
 
-    # Copy the rest of the application code to the container
-    COPY ../../src/jormungandr/jormungandr+build/jormungandr /app/jormungandr
-    COPY ../../src/jormungandr/jcli+build/jcli /app/jcli
-    COPY ../../src/catalyst-toolbox/catalyst-toolbox+build/catalyst-toolbox /app/catalyst-toolbox
-    COPY ../../src/voting-tools-rs+build/snapshot_tool /app/snapshot_tool
+    COPY entry.sh /app
+    RUN chmod +x /app/entry.sh
 
     ENV PATH=/app:$PATH
 

diff --git a/services/voting-node/pyproject.toml b/services/voting-node/pyproject.toml
@@ -4,7 +4,7 @@ version = "0.0.1"
 description = ""
 authors = ["Catalyst Core Developers <dev@iohk.io>"]
 license = "MIT or Apache License 2.0"
-readme = "development.md"
+readme = "readme.md"
 packages = [{include = "voting_node"}]
 
 [build-system]