diff options
| author | Sandra McCann <samccann@redhat.com> | 2020-05-29 18:48:53 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-29 18:48:53 +0200 |
| commit | f110bcd59e665c0d4a00623fd8f48050e61945c1 (patch) | |
| tree | d199f5d02e6a9d353adbde4292e28b8e0aa5cea5 /docs/docsite | |
| parent | ansible-test ansible-doc sanity test: also run with --json parameter (#69288) (diff) | |
| download | ansible-f110bcd59e665c0d4a00623fd8f48050e61945c1.tar.xz ansible-f110bcd59e665c0d4a00623fd8f48050e61945c1.zip | |
Turn on linkchecker in sphinx for documentation (#69590)
* add make linkcheckerdocs as option to verify external links
* add back anchor checks
* spacing nit
* fix shippable issue
* Update docs/docsite/rst/conf.py
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Diffstat (limited to 'docs/docsite')
| -rw-r--r-- | docs/docsite/Makefile | 3 | ||||
| -rw-r--r-- | docs/docsite/rst/conf.py | 7 |
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/docsite/Makefile b/docs/docsite/Makefile index ec59d5a3ca..3b0b512b24 100644 --- a/docs/docsite/Makefile +++ b/docs/docsite/Makefile @@ -46,6 +46,9 @@ htmldocs: generate_rst singlehtmldocs: generate_rst CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx singlehtml +linkcheckdocs: generate_rst + CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx linkcheck + webdocs: docs #TODO: leaving htmlout removal for those having older versions, should eventually be removed also diff --git a/docs/docsite/rst/conf.py b/docs/docsite/rst/conf.py index 8a76e89fd2..34f2b3d376 100644 --- a/docs/docsite/rst/conf.py +++ b/docs/docsite/rst/conf.py @@ -283,3 +283,10 @@ intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../pytho 'ansible_2_6': ('https://docs.ansible.com/ansible/2.6/', (None, '../ansible_2_6.inv')), 'ansible_2_5': ('https://docs.ansible.com/ansible/2.5/', (None, '../ansible_2_5.inv')), } + +# linckchecker settings +linkcheck_ignore = [ + r'http://irc\.freenode\.net', +] +linkcheck_workers = 25 +# linkcheck_anchors = False |