diff options
| author |   Rich Bennett <rb2745@att.com> | 2018-05-08 00:06:15 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2018-05-08 00:16:13 -0400 |
| commit | 3665e0909f08e90c4d7a3b990a49bd0035e7c8b1 (patch) | |
| tree | cab96e333a153c14d39320eaa3e9122dfdbc1331 /docs/conf.py | |
| parent | da9b65df495649b955d1bc8c235d3e07f234f7a1 (diff) | |
Add spellcheck and linkcheck exceptions
Add frequently used acronyms or words used in ONAP documentation
Add representative domain or IP addresses are not expected to pass a linkcheck
Add sphinx extension for drawing network diagrams
Change-Id: Iea76f4a279da755fdd5d87e3b723ef261b9d19cd
Issue-ID: DOC-262
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 31 |
1 files changed, 29 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index de65991d3..7126e3488 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,6 +38,7 @@ extensions = [ 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'sphinxcontrib.blockdiag', + 'sphinxcontrib.nwdiag', 'sphinxcontrib.seqdiag', 'sphinx.ext.ifconfig', 'sphinx.ext.todo', @@ -46,7 +47,8 @@ extensions = [ ] # Font path for seqdiag -seqdiag_fontpath= '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' +seqdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' +nwdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -375,4 +377,29 @@ epub_exclude_files = ['search.html'] #epub_use_index = True # Patterns to ignore in linkcheck builder -linkcheck_ignore = [r'http://localhost:\d+/'] +linkcheck_ignore = [ + r'http://localhost', + r'http://yourhostname', + r'http://{PDP_URL}:\d+/', + r'http://.*simpledemo.onap.org:\d+/', + r'http://load-balanced-address:\d+/', + r'http://127.0.0.1', + r'http://ESR_SERVER_IP:\d+/', + r'http://MSB_SERVER_IP:\d+/', + r'http://msb_docker_host_ip:\d+/', + r'http://msb.onap.org/', + r'http://\$msb_address/', + r'http://hostIP:\d+/', + r'https://\$CBAM_IP:\d+/', + r'http://app-host:port/', + r'http://servername.domain.com', + r'https://we-are-message-router.us:\d+/', + r'https://we-are-data-router.us:\d+/', + r'http://prov.datarouternew.com:8443/', + r'http://www.[host]:[port]/', + r'http:/$', + r'https:/$', + r'http://$', + r'https://$', + r'http://app-host:port/' + ] |