diff --git a/.github/workflows/module_docs_ci.yml b/.github/workflows/module_docs_ci.yml index 9f29772d6d..84c4d769a6 100644 --- a/.github/workflows/module_docs_ci.yml +++ b/.github/workflows/module_docs_ci.yml @@ -24,13 +24,11 @@ jobs: steps: - uses: actions/checkout@v4 - name: Build V - run: make -j4 + run: make -j4 && ./v symlink + - name: Install markdown from vpm + run: v retry -- v install markdown - name: Test v doc - run: | - # While the integration tests (executing the v doc command) should install - # markdown automatically, unit tests won't. Run integration tests first. - ./v test cmd/tools/vdoc/tests/ - ./v test cmd/tools/vdoc/*.v + run: ./v test cmd/tools/vdoc/ - name: Build module documentation run: ./v doc -m -f html vlib/ - name: Deploy docs to vercel diff --git a/TESTS.md b/TESTS.md index 3ad3cf35bb..3ccb470ca8 100644 --- a/TESTS.md +++ b/TESTS.md @@ -191,5 +191,5 @@ The VDOC test vdoc_file_test.v now also supports VAUTOFIX, which is useful, if you change anything inside cmd/tools/vdoc or vlib/v/doc/, or inside the modules that it depends on (like markdown). After such changes, just run this command *2 times*, and commit the -resulting changes in `cmd/tools/vdoc/tests/testdata` as well: -`VAUTOFIX=1 ./v cmd/tools/vdoc/tests/vdoc_file_test.v` +resulting changes in `cmd/tools/vdoc/testdata` as well: +`VAUTOFIX=1 ./v cmd/tools/vdoc/vdoc_file_test.v` diff --git a/cmd/tools/vdoc/tests/testdata/basic/basic.comments.out b/cmd/tools/vdoc/testdata/basic/basic.comments.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/basic/basic.comments.out rename to cmd/tools/vdoc/testdata/basic/basic.comments.out diff --git a/cmd/tools/vdoc/tests/testdata/basic/basic.out b/cmd/tools/vdoc/testdata/basic/basic.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/basic/basic.out rename to cmd/tools/vdoc/testdata/basic/basic.out diff --git a/cmd/tools/vdoc/tests/testdata/basic/basic.v b/cmd/tools/vdoc/testdata/basic/basic.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/basic/basic.v rename to cmd/tools/vdoc/testdata/basic/basic.v diff --git a/cmd/tools/vdoc/tests/testdata/comments/main.comments.out b/cmd/tools/vdoc/testdata/comments/main.comments.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/comments/main.comments.out rename to cmd/tools/vdoc/testdata/comments/main.comments.out diff --git a/cmd/tools/vdoc/tests/testdata/comments/main.out b/cmd/tools/vdoc/testdata/comments/main.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/comments/main.out rename to cmd/tools/vdoc/testdata/comments/main.out diff --git a/cmd/tools/vdoc/tests/testdata/comments/main.v b/cmd/tools/vdoc/testdata/comments/main.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/comments/main.v rename to cmd/tools/vdoc/testdata/comments/main.v diff --git a/cmd/tools/vdoc/tests/testdata/multiline/main.comments.out b/cmd/tools/vdoc/testdata/multiline/main.comments.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/multiline/main.comments.out rename to cmd/tools/vdoc/testdata/multiline/main.comments.out diff --git a/cmd/tools/vdoc/tests/testdata/multiline/main.out b/cmd/tools/vdoc/testdata/multiline/main.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/multiline/main.out rename to cmd/tools/vdoc/testdata/multiline/main.out diff --git a/cmd/tools/vdoc/tests/testdata/multiline/main.v b/cmd/tools/vdoc/testdata/multiline/main.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/multiline/main.v rename to cmd/tools/vdoc/testdata/multiline/main.v diff --git a/cmd/tools/vdoc/tests/testdata/newlines/main.comments.out b/cmd/tools/vdoc/testdata/newlines/main.comments.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/newlines/main.comments.out rename to cmd/tools/vdoc/testdata/newlines/main.comments.out diff --git a/cmd/tools/vdoc/tests/testdata/newlines/main.out b/cmd/tools/vdoc/testdata/newlines/main.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/newlines/main.out rename to cmd/tools/vdoc/testdata/newlines/main.out diff --git a/cmd/tools/vdoc/tests/testdata/newlines/main.v b/cmd/tools/vdoc/testdata/newlines/main.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/newlines/main.v rename to cmd/tools/vdoc/testdata/newlines/main.v diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/README.md b/cmd/tools/vdoc/testdata/output_formats/README.md similarity index 100% rename from cmd/tools/vdoc/tests/testdata/output_formats/README.md rename to cmd/tools/vdoc/testdata/output_formats/README.md diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.ansi b/cmd/tools/vdoc/testdata/output_formats/main.ansi similarity index 100% rename from cmd/tools/vdoc/tests/testdata/output_formats/main.ansi rename to cmd/tools/vdoc/testdata/output_formats/main.ansi diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.html b/cmd/tools/vdoc/testdata/output_formats/main.html similarity index 100% rename from cmd/tools/vdoc/tests/testdata/output_formats/main.html rename to cmd/tools/vdoc/testdata/output_formats/main.html diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.text b/cmd/tools/vdoc/testdata/output_formats/main.text similarity index 100% rename from cmd/tools/vdoc/tests/testdata/output_formats/main.text rename to cmd/tools/vdoc/testdata/output_formats/main.text diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.v b/cmd/tools/vdoc/testdata/output_formats/main.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/output_formats/main.v rename to cmd/tools/vdoc/testdata/output_formats/main.v diff --git a/cmd/tools/vdoc/tests/testdata/readme_in_project_root/README.md b/cmd/tools/vdoc/testdata/readme_in_project_root/README.md similarity index 100% rename from cmd/tools/vdoc/tests/testdata/readme_in_project_root/README.md rename to cmd/tools/vdoc/testdata/readme_in_project_root/README.md diff --git a/cmd/tools/vdoc/tests/testdata/readme_in_project_root/src/main.comments.out b/cmd/tools/vdoc/testdata/readme_in_project_root/src/main.comments.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/readme_in_project_root/src/main.comments.out rename to cmd/tools/vdoc/testdata/readme_in_project_root/src/main.comments.out diff --git a/cmd/tools/vdoc/tests/testdata/readme_in_project_root/src/main.readme.comments.out b/cmd/tools/vdoc/testdata/readme_in_project_root/src/main.readme.comments.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/readme_in_project_root/src/main.readme.comments.out rename to cmd/tools/vdoc/testdata/readme_in_project_root/src/main.readme.comments.out diff --git a/cmd/tools/vdoc/tests/testdata/readme_in_project_root/src/main.v b/cmd/tools/vdoc/testdata/readme_in_project_root/src/main.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/readme_in_project_root/src/main.v rename to cmd/tools/vdoc/testdata/readme_in_project_root/src/main.v diff --git a/cmd/tools/vdoc/tests/testdata/readme_in_project_root/v.mod b/cmd/tools/vdoc/testdata/readme_in_project_root/v.mod similarity index 100% rename from cmd/tools/vdoc/tests/testdata/readme_in_project_root/v.mod rename to cmd/tools/vdoc/testdata/readme_in_project_root/v.mod diff --git a/cmd/tools/vdoc/tests/testdata/run_examples_bad/.v.mod.stop b/cmd/tools/vdoc/testdata/run_examples_bad/.v.mod.stop similarity index 100% rename from cmd/tools/vdoc/tests/testdata/run_examples_bad/.v.mod.stop rename to cmd/tools/vdoc/testdata/run_examples_bad/.v.mod.stop diff --git a/cmd/tools/vdoc/tests/testdata/run_examples_bad/main.comments.out b/cmd/tools/vdoc/testdata/run_examples_bad/main.comments.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/run_examples_bad/main.comments.out rename to cmd/tools/vdoc/testdata/run_examples_bad/main.comments.out diff --git a/cmd/tools/vdoc/tests/testdata/run_examples_bad/main.out b/cmd/tools/vdoc/testdata/run_examples_bad/main.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/run_examples_bad/main.out rename to cmd/tools/vdoc/testdata/run_examples_bad/main.out diff --git a/cmd/tools/vdoc/tests/testdata/run_examples_bad/main.v b/cmd/tools/vdoc/testdata/run_examples_bad/main.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/run_examples_bad/main.v rename to cmd/tools/vdoc/testdata/run_examples_bad/main.v diff --git a/cmd/tools/vdoc/tests/testdata/run_examples_good/.v.mod.stop b/cmd/tools/vdoc/testdata/run_examples_good/.v.mod.stop similarity index 100% rename from cmd/tools/vdoc/tests/testdata/run_examples_good/.v.mod.stop rename to cmd/tools/vdoc/testdata/run_examples_good/.v.mod.stop diff --git a/cmd/tools/vdoc/tests/testdata/run_examples_good/main.comments.out b/cmd/tools/vdoc/testdata/run_examples_good/main.comments.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/run_examples_good/main.comments.out rename to cmd/tools/vdoc/testdata/run_examples_good/main.comments.out diff --git a/cmd/tools/vdoc/tests/testdata/run_examples_good/main.out b/cmd/tools/vdoc/testdata/run_examples_good/main.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/run_examples_good/main.out rename to cmd/tools/vdoc/testdata/run_examples_good/main.out diff --git a/cmd/tools/vdoc/tests/testdata/run_examples_good/main.v b/cmd/tools/vdoc/testdata/run_examples_good/main.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/run_examples_good/main.v rename to cmd/tools/vdoc/testdata/run_examples_good/main.v diff --git a/cmd/tools/vdoc/tests/testdata/unsorted/main.out b/cmd/tools/vdoc/testdata/unsorted/main.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/unsorted/main.out rename to cmd/tools/vdoc/testdata/unsorted/main.out diff --git a/cmd/tools/vdoc/tests/testdata/unsorted/main.unsorted.out b/cmd/tools/vdoc/testdata/unsorted/main.unsorted.out similarity index 100% rename from cmd/tools/vdoc/tests/testdata/unsorted/main.unsorted.out rename to cmd/tools/vdoc/testdata/unsorted/main.unsorted.out diff --git a/cmd/tools/vdoc/tests/testdata/unsorted/main.v b/cmd/tools/vdoc/testdata/unsorted/main.v similarity index 100% rename from cmd/tools/vdoc/tests/testdata/unsorted/main.v rename to cmd/tools/vdoc/testdata/unsorted/main.v diff --git a/cmd/tools/vdoc/tests/vdoc_file_test.v b/cmd/tools/vdoc/vdoc_file_test.v similarity index 97% rename from cmd/tools/vdoc/tests/vdoc_file_test.v rename to cmd/tools/vdoc/vdoc_file_test.v index 6e99f8cfaf..13a9cdf5d3 100644 --- a/cmd/tools/vdoc/tests/vdoc_file_test.v +++ b/cmd/tools/vdoc/vdoc_file_test.v @@ -13,8 +13,9 @@ fn test_output() { os.setenv('VCOLORS', 'never', true) os.chdir(vroot)! mut total_fails := 0 - test_files := vtest.filter_vtest_only(os.walk_ext('cmd/tools/vdoc/tests/testdata', - '.v'), basepath: vroot) + test_files := vtest.filter_vtest_only(os.walk_ext('cmd/tools/vdoc/testdata', '.v'), + basepath: vroot + ) for path in test_files { mut fails := 0 qpath := os.quoted_path(path) @@ -45,7 +46,7 @@ fn test_output() { fn test_run_examples_good() { os.setenv('VCOLORS', 'never', true) os.chdir(vroot)! - res := os.execute('${vexe} doc -comments -run-examples cmd/tools/vdoc/tests/testdata/run_examples_good/main.v') + res := os.execute('${vexe} doc -comments -run-examples cmd/tools/vdoc/testdata/run_examples_good/main.v') assert res.exit_code == 0 assert res.output.contains('module main'), res.output assert res.output.contains('fn abc()'), res.output @@ -57,7 +58,7 @@ fn test_run_examples_good() { fn test_run_examples_bad() { os.setenv('VCOLORS', 'never', true) os.chdir(vroot)! - res := os.execute('${vexe} doc -comments -run-examples cmd/tools/vdoc/tests/testdata/run_examples_bad/main.v') + res := os.execute('${vexe} doc -comments -run-examples cmd/tools/vdoc/testdata/run_examples_bad/main.v') assert res.exit_code != 0 assert res.output.contains('error in documentation example'), res.output assert res.output.contains(' left value: 5 * 5 = 25'), res.output