Separate docs environment (#1600)

* Separate env for docs

.github/workflows/docker-amd64.yml

@@ -66,7 +66,7 @@ jobs:
       - name: Install Dev Dependencies
         run: |
           python -m pip install --upgrade pip
-          make -C main dev-env
+          make -C main install-dev-env
 
       - name: Build Docker Images
         run: make -C main build-all

.github/workflows/docker.yml

@@ -83,7 +83,7 @@ jobs:
       - name: Install Dev Dependencies
         run: |
           python -m pip install --upgrade pip
-          make -C main dev-env
+          make -C main install-dev-env
 
       - name: Build Docker Images
         run: make -C main build-all-multi

.github/workflows/sphinx.yml

@@ -7,7 +7,7 @@ on:
 
       - "docs/**"
       - ".readthedocs.yaml"
-      - "requirements-dev.txt"
+      - "requirements-docs.txt"
   push:
     branches:
       - main
@@ -17,7 +17,7 @@ on:
 
       - "docs/**"
       - ".readthedocs.yaml"
-      - "requirements-dev.txt"
+      - "requirements-docs.txt"
   workflow_dispatch:
 
 jobs:
@@ -39,7 +39,7 @@ jobs:
       - name: Install Dev Dependencies
         run: |
           python -m pip install --upgrade pip
-          make dev-env
+          make install-docs-env
 
       - name: Build Documentation
         run: make docs

.readthedocs.yaml

@@ -27,4 +27,4 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-    - requirements: requirements-dev.txt
+    - requirements: requirements-docs.txt

Makefile

@@ -132,7 +132,7 @@ dev/%: PORT?=8888
 dev/%: ## run a foreground container for a stack
 	docker run -it --rm -p $(PORT):8888 $(DARGS) $(OWNER)/$(notdir $@)
 
-dev-env: ## install libraries required to build docs and run tests
+install-dev-env: ## install libraries required to build images and run tests
 	@pip install -r requirements-dev.txt
 
 
@@ -140,6 +140,9 @@ dev-env: ## install libraries required to build docs and run tests
 docs: ## build HTML documentation
 	sphinx-build docs/ docs/_build/
 
+install-docs-env: ## install libraries required to build docs
+	@pip install -r requirements-docs.txt
+
 
 
 hook/%: WIKI_PATH?=../wiki

docs/contributing/lint.md

@@ -13,7 +13,7 @@ This can be achieved by using the generic task used to install all Python develo
 
 ```sh
 # Install all development dependencies for the project
-make dev-env
+make install-dev-env
 # It can also be installed directly
 pip install pre-commit
 ```

docs/maintaining/tasks.md

@@ -24,7 +24,7 @@ Pushing `Run Workflow` button will trigger this process.
 ## Adding a New Core Image to Docker Hub
 
 ```{note}
-In general, we do not add new core images and ask contributors to either create a [recipe](../using/recipes.md) or [community stack](../using/stacks.md).
+In general, we do not add new core images and ask contributors to either create a [recipe](../using/recipes.md) or [community stack](../contributing/stacks.md).
 ```
 
 When there's a new stack definition, do the following before merging the PR with the new stack:

requirements-dev.txt

@@ -1,10 +1,7 @@
 docker
-myst-parser
 packaging
 plumbum
 pre-commit
 pytest
 requests
-sphinx
-sphinx-copybutton
 tabulate

requirements-docs.txt

@@ -0,0 +1,3 @@
+myst-parser
+sphinx
+sphinx-copybutton