From ed9890af1161539d9e94e96b92cbab79f7d6900c Mon Sep 17 00:00:00 2001 From: DevKage <33748002+ufrshubham@users.noreply.github.com> Date: Sun, 2 Oct 2022 15:05:23 +0530 Subject: [PATCH] fix: Melos sphinx scripts windows (#1985) melos doc-xyz commands were not working on Windows as SOURCEDIR was not properly getting set. I tried changing it to use set SOURCEDIR="$MELOS_ROOT_PATH/doc" and set SOURCEDIR="%MELOS_ROOT_PATH%/doc", but both didn't work. As SOURCEDIR isn't really necessary to be set for the commands to work, this PR remove that variable and directly using $MELOS_ROOT_PATH/doc in its place. Additionally, this PR also adds .venv (a common folder storing virtual env) to gitignore. --- .gitignore | 1 + melos.yaml | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index ecf378753..b6808d431 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ pubspec.lock packages/flame/doc/api/ .flutter-plugins .vscode/ +.venv/ **/.flutter-plugins **/.flutter-plugins-dependencies **/pubspec_overrides.yaml diff --git a/melos.yaml b/melos.yaml index e0b220a21..5ef962aa6 100644 --- a/melos.yaml +++ b/melos.yaml @@ -52,19 +52,19 @@ scripts: description: Run dartdoc checks for all packages. doc-build: - run: SOURCEDIR="$MELOS_ROOT_PATH/doc" && cd "$SOURCEDIR/_sphinx" && make html + run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && make html description: Create the sphinx html docs. doc-build-live: - run: SOURCEDIR="$MELOS_ROOT_PATH/doc" && cd "$SOURCEDIR/_sphinx" && make livehtml + run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && make livehtml description: Recompiles the docs enerytime there is a change in them and opens your browser. doc-clean: - run: SOURCEDIR="$MELOS_ROOT_PATH/doc" && cd "$SOURCEDIR/_sphinx" && make clean + run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && make clean description: Removes all Sphinx's cached generated files. doc-linkcheck: - run: SOURCEDIR="$MELOS_ROOT_PATH/doc" && cd "$SOURCEDIR/_sphinx" && make linkcheck + run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && make linkcheck description: Checks whether there are any broken links in the docs. test:select: