-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add basic Sphinx docs based on rocThrust * Fix Sphinx errors * Update copyright date Co-authored-by: Cory Bloor <[email protected]>
- Loading branch information
1 parent
e54e8fd
commit ec415b2
Showing
12 changed files
with
417 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| #!/usr/bin/env groovy | ||
| // This shared library is available at https://github.com/ROCmSoftwarePlatform/rocJENKINS/ | ||
| @Library('rocJenkins@pong') _ | ||
|
|
||
| // This is file for internal AMD use. | ||
| // If you are interested in running your own Jenkins, please raise a github issue for assistance. | ||
|
|
||
| import com.amd.project.* | ||
| import com.amd.docker.* | ||
| import java.nio.file.Path | ||
|
|
||
| def runCompileCommand(platform, project, jobName, boolean debug=false) | ||
| { | ||
| project.paths.construct_build_prefix() | ||
|
|
||
| def command = """#!/usr/bin/env bash | ||
| set -x | ||
| ${project.paths.project_build_prefix}/docs/run_doc.sh | ||
| """ | ||
|
|
||
| try | ||
| { | ||
| platform.runCommand(this, command) | ||
| } | ||
| catch(e) | ||
| { | ||
| throw e | ||
| } | ||
|
|
||
| publishHTML([allowMissing: false, | ||
| alwaysLinkToLastBuild: false, | ||
| keepAll: false, | ||
| reportDir: "${project.paths.project_build_prefix}/docs/_build/html", | ||
| reportFiles: "index.html", | ||
| reportName: "Documentation", | ||
| reportTitles: "Documentation"]) | ||
| } | ||
|
|
||
| def runCI = | ||
| { | ||
| nodeDetails, jobName-> | ||
|
|
||
| def prj = new rocProject('hipCUB', 'StaticAnalysis') | ||
|
|
||
| // Define test architectures, optional rocm version argument is available | ||
| def nodes = new dockerNodes(nodeDetails, jobName, prj) | ||
|
|
||
| boolean formatCheck = false | ||
| boolean staticAnalysis = true | ||
|
|
||
| def compileCommand = | ||
| { | ||
| platform, project-> | ||
|
|
||
| runCompileCommand(platform, project, jobName, false) | ||
| } | ||
|
|
||
| buildProject(prj , formatCheck, nodes.dockerArray, compileCommand, null, null, staticAnalysis) | ||
| } | ||
|
|
||
| ci: { | ||
| String urlJobName = auxiliary.getTopJobName(env.BUILD_URL) | ||
|
|
||
| properties(auxiliary.addCommonProperties([pipelineTriggers([cron('0 1 * * 6')])])) | ||
| stage(urlJobName) { | ||
| runCI([ubuntu18:['any']], urlJobName) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Minimal makefile for Sphinx documentation | ||
| # | ||
|
|
||
| # You can set these variables from the command line. | ||
| SPHINXOPTS = | ||
| SPHINXBUILD = sphinx-build | ||
| SPHINXPROJ = hipCUB | ||
| SOURCEDIR = . | ||
| BUILDDIR = _build | ||
|
|
||
| # Put it first so that "make" without argument is like "make help". | ||
| help: | ||
| @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
|
||
| .PHONY: help Makefile clean | ||
|
|
||
| # Catch-all target: route all unknown targets to Sphinx using the new | ||
| # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
| %: Makefile | ||
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
|
||
| clean: | ||
| rm -rf docBin/ api/ | ||
| @$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
Oops, something went wrong.