diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/build_reference.ps1 | 4 | ||||
| -rw-r--r-- | docs/doc-system.md | 2 | ||||
| -rw-r--r-- | docs/stdlib-docgen.md | 6 |
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/build_reference.ps1 b/docs/build_reference.ps1 index ebf745244..0aa424771 100644 --- a/docs/build_reference.ps1 +++ b/docs/build_reference.ps1 @@ -33,7 +33,7 @@ Remove-Item -Path ".\stdlib-reference\attributes" -Recurse -Force git describe --tags | Out-File -FilePath ".\stdlib-reference\_includes\version.inc" -Encoding ASCII cd stdlib-reference -& ../../build/Release/bin/slangc -compile-stdlib -doc +& ../../build/Release/bin/slangc -compile-core-module -doc Move-Item -Path ".\toc.html" -Destination ".\_includes\stdlib-reference-toc.html" -Force git config user.email "bot@shader-slang.com" git config user.name "Stdlib Reference Bot" @@ -49,4 +49,4 @@ cd ../ # Copy-Item -Path .\stdlib-reference\global-decls -Destination D:\git_repo\stdlib-reference\global-decls -Recurse -Force # Copy-Item -Path .\stdlib-reference\interfaces -Destination D:\git_repo\stdlib-reference\interfaces -Recurse -Force # Copy-Item -Path .\stdlib-reference\types -Destination D:\git_repo\stdlib-reference\types -Recurse -Force -# Copy-Item -Path .\stdlib-reference\_includes\stdlib-reference-toc.html -Destination D:\git_repo\stdlib-reference\_includes\stdlib-reference-toc.html -Force
\ No newline at end of file +# Copy-Item -Path .\stdlib-reference\_includes\stdlib-reference-toc.html -Destination D:\git_repo\stdlib-reference\_includes\stdlib-reference-toc.html -Force diff --git a/docs/doc-system.md b/docs/doc-system.md index 56635e4ed..1eb55f817 100644 --- a/docs/doc-system.md +++ b/docs/doc-system.md @@ -88,7 +88,7 @@ Currently the only documentation style supported is a single file 'markdown' out It is possible to generate documentation for Slangs internal `stdlib`. This can be achieved with `slangc` via ``` -slangc -doc -compile-stdlib +slangc -doc -compile-core-module ``` The documentation will be written to a file `stdlib-doc.md`. diff --git a/docs/stdlib-docgen.md b/docs/stdlib-docgen.md index df9317de9..0be3af548 100644 --- a/docs/stdlib-docgen.md +++ b/docs/stdlib-docgen.md @@ -19,7 +19,7 @@ rm -rf ./global-decls rm -rf ./attributes # generate updated pages -slangc -compile-stdlib -doc +slangc -compile-core-module -doc # optional: move generated toc.html to `_includes` mv toc.html ./_includes/stdlib-reference-toc.html @@ -96,7 +96,7 @@ as with `@remarks`. - Include examples if needed in the examples section. - Provide a see also section with links to related declarations. -After updating comments, build `slangc`, and run `slangc -compile-stdlib -doc` in `stdlib-reference` diretory to update the markdown files for preview. +After updating comments, build `slangc`, and run `slangc -compile-core-module -doc` in `stdlib-reference` diretory to update the markdown files for preview. Your PR only needs to include changes to *.meta.slang files. Once your PR is merged, slang CI will run `slangc` and push the updated markdown files to the `stdlib-reference` repo. @@ -111,4 +111,4 @@ C++'s visiblity modifiers: they apply to everything after it. To preview github pages locally, you need to follow instructions on setting up Jekyll: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll -You will need to use Jekyll to create a Gem file before serving it.
\ No newline at end of file +You will need to use Jekyll to create a Gem file before serving it. |