chore: generate artifacts for the docs build in the CI · mohammadmoth/python-gitlab@85b43ae · GitHub

1. mohammadmoth
2. python-gitlab

Repository navigation

• Code
• Pull requests
• Actions
• Projects
• Security and quality
• Insights

Commit 85b43ae

Browse filesBrowse the repository at this point in the historyBrowse files

JohnVillalovos

committed

chore: generate artifacts for the docs build in the CI

When building the docs store the created documentation as an artifact so that it can be viewed. This will create a html-docs.zip file which can be downloaded containing the contents of the `build/sphinx/html/` directory. It can be downloaded, extracted, and then viewed. This can be useful in reviewing changes to the documentation. See https://github.com/actions/upload-artifact for more information on how this works.

1 parent 83dcabf commit 85b43ae
Copy full SHA for 85b43ae

1 file changed

+5Lines changed: 5 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• .github/workflows
  • docs.yml

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎.github/workflows/docs.yml‎

Copy file name to clipboardExpand all lines: .github/workflows/docs.yml

+5Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -33,6 +33,11 @@ jobs:
33	33	env:
34	34	TOXENV: docs
35	35	run: tox
	36	+ - name: Archive generated docs
	37	+ uses: actions/upload-artifact@v2
	38	+ with:
	39	+ name: html-docs
	40	+ path: build/sphinx/html/
36	41
37	42	twine-check:
38	43	runs-on: ubuntu-20.04

0 commit comments

Comments

0 (0)