Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
vision
Commits
90a6206c
Unverified
Commit
90a6206c
authored
May 05, 2021
by
Nicolas Hug
Committed by
GitHub
May 05, 2021
Browse files
Show built doc links directly in PR GUI -- v2 (#3734)
parent
37828883
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
22 additions
and
0 deletions
+22
-0
.github/workflows/show_link_to_built_docs.yml
.github/workflows/show_link_to_built_docs.yml
+18
-0
CONTRIBUTING.md
CONTRIBUTING.md
+4
-0
No files found.
.github/workflows/show_link_to_built_docs.yml
0 → 100644
View file @
90a6206c
name
:
Show CI job with links to built docs
on
:
pull_request
:
branches
:
[
master
]
jobs
:
circleci_artifacts_redirector_job
:
runs-on
:
ubuntu-latest
name
:
Run CircleCI artifacts redirector
steps
:
-
name
:
GitHub Action step
uses
:
larsoner/circleci-artifacts-redirector-action@master
with
:
repo-token
:
${{ secrets.GITHUB_TOKEN }}
artifact-path
:
0/docs/index.html
circleci-jobs
:
build_docs
job-title
:
See the built docs here!
CONTRIBUTING.md
View file @
90a6206c
...
...
@@ -125,6 +125,10 @@ make html
Then open
`docs/build/html/index.html`
in your favorite browser.
The docs are also automatically built when you submit a PR. The job that
builds the docs is named
`build_docs`
. If that job passes, a link to the
rendered docs will be available in a job called
`See the built docs here!`
.
### New model
More details on how to add a new model will be provided later. Please, do not send any PR with a new model without discussing
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment