Commitbeb2f24

authored and

committed

chore(dev): add option for serving docs locally

This update can be helpful when changing documentation by serving the docs locally to ensure content presentation and format is as-expected.

1 parentf36614f commitbeb2f24Copy full SHA for beb2f24

File tree

+18

-2

lines changed

+18

-2

lines changed

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -81,6 +81,9 @@ You need to install ``tox`` (``pip3 install tox``) to run tests and lint checks
`81`	`81`	`# build the documentation - the result will be generated in build/sphinx/html/:`
`82`	`82`	`tox -e docs`
`83`	`83`
	`84`	`+# build and serve the documentation site locally for validating changes`
	`85`	`+ tox -e docs-serve`
	`86`	`+`
`84`	`87`	`# List all available tox environments`
`85`	`88`	`tox list`
`86`	`89`

Lines changed: 1 addition & 0 deletions

Lines changed: 14 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,10 @@ passenv =`
`26`	`26`	`NO_COLOR`
`27`	`27`	`PWD`
`28`	`28`	`PY_COLORS`
`29`		`-setenv =VIRTUAL_ENV={envdir}`
	`29`	`+setenv =`
	`30`	`+DOCS_SOURCE = docs`
	`31`	`+DOCS_BUILD = build/sphinx/html`
	`32`	`+VIRTUAL_ENV={envdir}`
`30`	`33`	`whitelist_externals = true`
`31`	`34`	`usedevelop = True`
`32`	`35`	`install_command = pip install {opts} {packages} -e .`
`@@ -99,8 +102,17 @@ per-file-ignores =`
`99`	`102`	`gitlab/v4/objects/__init__.py:F401,F403`
`100`	`103`
`101`	`104`	`[testenv:docs]`
	`105`	`+description = Builds the docs site. Generated HTML files will be available in'{env:DOCS_BUILD}'.`
`102`	`106`	`deps = -r{toxinidir}/requirements-docs.txt`
`103`		`-commands = sphinx-build -n -W --keep-going -b html docs build/sphinx/html`
	`107`	`+commands = sphinx-build -n -W --keep-going -b html {env:DOCS_SOURCE} {env:DOCS_BUILD}`
	`108`	`+`
	`109`	`+[testenv:docs-serve]`
	`110`	`+description =`
	`111`	`+ Builds and serves the HTML docs site locally. \`
	`112`	`+ Use this for verifying updates to docs. \`
	`113`	`+ Changes to docs files will be automatically rebuilt and served.`
	`114`	`+deps = -r{toxinidir}/requirements-docs.txt`
	`115`	`+commands = sphinx-autobuild {env:DOCS_SOURCE} {env:DOCS_BUILD} --open-browser --port 8000`
`104`	`116`
`105`	`117`	`[testenv:cover]`
`106`	`118`	`commands =`

Comments

(0)