chore: move docs dependencies to main pyproject.toml

fpgmaas · Nov 13, 2022 · acca4cf · acca4cf
1 parent 44cfb40
commit acca4cf
Show file tree

Hide file tree

Showing 16 changed files with 428 additions and 613 deletions.
diff --git a/.github/actions/check-docs/action.yml b/.github/actions/check-docs/action.yml
diff --git a/.github/actions/deploy-docs/action.yml b/.github/actions/deploy-docs/action.yml
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -64,5 +64,8 @@ jobs:
       - name: Check out
         uses: actions/checkout@v3
 
-      - name: check documentation
-        uses: ./.github/actions/check-docs
+      - name: Set up the environment
+        uses: ./.github/actions/setup-poetry-env
+
+      - name: Check if documentation can be built
+        run: poetry run mkdocs build -s
diff --git a/.github/workflows/on-release-main.yml b/.github/workflows/on-release-main.yml
@@ -34,5 +34,8 @@ jobs:
       - name: Check out
         uses: actions/checkout@v3
 
-      - name: check documentation
-        uses: ./.github/actions/deploy-docs
+      - name: Set up the environment
+        uses: ./.github/actions/setup-poetry-env
+
+      - name: Deploy documentation
+        run: poetry run mkdocs gh-deploy --force
diff --git a/Makefile b/Makefile
@@ -41,11 +41,11 @@ build-and-publish: build publish ## Build and publish.
 
 .PHONY: docs-test
 docs-test: ## Test if documentation can be built without warnings or errors.
-	@( cd docs ; poetry run mkdocs build -s)
+	@poetry run mkdocs build -s
 
 .PHONY: docs
 docs: ## Build and serve the documentation.
-	@( cd docs ; poetry run mkdocs serve )
+	@poetry run mkdocs serve
 
 .PHONY: help
 help: ## Show help for the commands.

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <img width="460" height="300" src="https://raw.githubusercontent.com/fpgmaas/deptry/main/docs/docs/static/deptry_Logo-01.svg">
+  <img width="460" height="300" src="https://raw.githubusercontent.com/fpgmaas/deptry/main/docs/static/deptry_Logo-01.svg">
 </p>
 
 ---

diff --git a/docs/docs/faq.md → docs/faq.md b/docs/docs/faq.md → docs/faq.md
diff --git a/docs/docs/index.md → docs/index.md b/docs/docs/index.md → docs/index.md