Skip to content

Commit 062cb8f

Browse files
committed
Improve guidance for Makefiles added for mkdocs tool
1 parent 32e48ee commit 062cb8f

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ Command `mkdocs build` to build the documentation.
245245
the MSYS2 environment:
246246
247247
~~~text
248-
stack exec -- pacman --sync python libxml2-devel libxslt-devel
248+
stack exec -- pacman --sync python make libxml2-devel libxslt-devel
249249
~~~
250250
251251
!!! note

Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# This file allows users of the 'make' tool to automate the use of the 'mkdocs'
2-
# tool to preview or build Stack's online documentation.
1+
# With the other prerequisites, this file allows users of the 'make' tool to
2+
# automate the use of the 'mkdocs' tool to preview or build Stack's online
3+
# documentation. See CONTRIBUTING.md for more information.
34

45
# Preview Stack's online documentation with `make docs-serve`:
56
.PHONY: docs-serve

doc/Makefile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# This file allows users of the 'make' tool to automate the use of the 'mkdocs'
2-
# tool to preview or build Stack's online documentation. See the file 'Makefile'
3-
# in Stack's project directory for more information.
1+
# With the necessary prerequisites, this file allows users of the 'make' tool to
2+
# automate the use of the 'mkdocs' tool to preview or build Stack's online
3+
# documentation. See CONTRIBUTING.md and the file 'Makefile' in Stack's project
4+
# directory for more information.
45

56
PYTHON_VIRTUALENV:=.python-doc-virtualenv
67
MK_DOCS_CMD:=$(PYTHON_VIRTUALENV)/bin/mkdocs

0 commit comments

Comments
 (0)