summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2018-05-08 00:06:15 -0400
committerRich Bennett <rb2745@att.com>2018-05-08 00:16:13 -0400
commit3665e0909f08e90c4d7a3b990a49bd0035e7c8b1 (patch)
treecab96e333a153c14d39320eaa3e9122dfdbc1331
parentda9b65df495649b955d1bc8c235d3e07f234f7a1 (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>
-rw-r--r--docs/conf.py31
-rw-r--r--docs/validwords.txt427
-rw-r--r--etc/requirements.txt1
3 files changed, 453 insertions, 6 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/'
+ ]
diff --git a/docs/validwords.txt b/docs/validwords.txt
index b9c90bb10..ea1daa962 100644
--- a/docs/validwords.txt
+++ b/docs/validwords.txt
@@ -1,7 +1,10 @@
AAF
AAI
+adaptor
+Adaptor
+adaptors
+Adaptors
Alcatel
-amsterdam
Ansible
API
APIs
@@ -15,18 +18,434 @@ Cassandra
CCSDK
CD
CDAP
-cdrom
-ceilometer
Ceilometer
CentOS
-Ceph
CI
CLI
Cloudify
+Codec
committer
committers
CommonMark
Contrail
CPU
+CRM
+CSCF
CSIT
+cyber
+DBaaS
+DCAE
+DevOps
+DHCP
+Django
+DMaaP
+DNS
+DNSaaS
+DPDK
+Ebook
+elasticsearch
+Elasticsearch
+Enablement
+enum
+Enum
+env
+Env
+ENV
+ethernet
+Facebook
+failover
+fallback
+Fcaps
+Financials
+geocoder
+Gerrit
+Github
+graphSON
+guestOS
+gui
+Hadoop
+hardcoded
+hashtag
+healthcheck
+healthCheck
+Healthcheck
+HealthCheck
+healthchecks
+heatbridge
+heatclient
+HeatStack
+hostname
+hostName
+Hostname
+hostnames
+hostOS
+htm
+html
+http
+Http
+httpclient
+httpcomponents
+httpdomain
+httpHeader
+httpPort
+httpreturncode
+https
+httpStatusCode
+Huawei
+hyperlink
+Hyperlink
+hypervisor
+Hypervisor
+hypervisors
+Hypervisors
+IaaS
+indices
+Indices
+inline
+internet
+interoperable
+interoperate
+Interoperate
+interoperation
+interwork
+Interworking
+IoT
+ip
+Ip
+IP
+ipAddress
+iPAddress
+IPAddress
+ipam
+Ipam
+ipVersion
+Jacoco
+java
+javalib
+javascript
+Javascript
+jboss
+JBoss
+Jenkin
+Jira
+jpath
+json
+Json
+jsonObject
+jsonObjectInstance
+jsonObjects
+jsonschema
+jtosca
+junit
+Junit
+JUnit
+Junits
+JUnits
+keypair
+Keypair
+keypairs
+keyserver
+keyservers
+keyspace
+Keyspace
+keyspaceName
+keyspaces
+keystore
+keytool
+keyValue
+Kibana
+Kibibytes
+Kubernetes
+LF
+lifecycle
+Lifecycle
+lifecycles
+locator
+logback
+Logback
+logfiles
+Logfiles
+logoffs
+Logoffs
+logon
+Logstash
+macAddress
+MacAddress
+macOS
+Malware
+metadata
+Metadata
+microservice
+Microservice
+microservices
+Microservices
+middleware
+msb
+MSB
+multicast
+multicloud
+Multicloud
+MultiCloud
+multipart
+Mysql
+NaaS
+nameserver
+nameservers
+namespace
+Namespace
+namespaced
+namespaces
+Namespaces
+Netconf
+nfv
+NFV
+nfvi
+nfvo
+nfvparser
+Nokia
+NSD
+OAM
+Ocata
+ODL
+Onap
ONAP
+onboard
+Onboard
+onboarded
+Onboarded
+onboarding
+Onboarding
+online
+OOF
+OOM
+OpenDaylight
+openo
+OpenO
+Opensource
+Openstack
+OpenStack
+OSS
+Pandoc
+partitionKey
+Partitionkey
+passphrase
+PCRF
+pdf
+PGaaS
+Phishing
+PKI
+placemark
+Placemark
+placemarks
+plantUML
+playbook
+Playbook
+playbooks
+Playbooks
+plugin
+Plugin
+plugins
+Plugins
+PNF
+PoC
+Postgre
+Postgres
+Postgresql
+preload
+Preload
+proactively
+programmatically
+proxyhost
+pserver
+pServer
+pservers
+QoS
+quickstart
+Quickstart
+Rackspace
+readme
+readthedocs
+Readthedocs
+Redhat
+Redis
+refactored
+Refactored
+registrator
+Registrator
+repo
+Repo
+repos
+Restconf
+reStructuredText
+reusability
+Reusability
+RMM
+roadmap
+roadmaps
+RPT
+rst
+RST
+RVMI
+schemas
+screensaver
+sdc
+Sdc
+SDC
+sdk
+SDK
+SDN
+sdnc
+Sdnc
+SDNC
+Seleniunm
+servlet
+Servlet
+Skynet
+SLI
+SMP
+SNMP
+SPI
+SQL
+stateful
+subclassed
+subclassing
+subdomain
+subflows
+suboperation
+suboperations
+Suboperations
+subtending
+syslog
+sysLog
+Syslog
+syslogs
+Syslogs
+tablename
+taxonomical
+TBD
+Telco
+telecom
+Telecom
+templated
+templating
+timeframe
+timeslots
+timestamp
+Timestamp
+transcoding
+UDP
+UI
+uncheck
+undeploy
+Undeploy
+undeployed
+undeploying
+Undeployment
+uninstall
+uninstallation
+uninstalled
+unitless
+Unregistration
+updatable
+uploadable
+url
+Url
+urls
+usecase
+Usecase
+userid
+username
+Username
+usernames
+validator
+Validator
+vcpu
+vcpus
+vdns
+versioned
+Versioned
+versioning
+Versioning
+vertices
+Vertices
+vf
+vF
+vfc
+vFC
+VFC
+vfcadaptor
+vfirewall
+vFirewall
+vfmodule
+vfModule
+VfModule
+vfModules
+vfstatus
+vfStatus
+virtualization
+Virtualization
+virtualize
+virtualized
+Virtualized
+virtualizes
+virtualizing
+vlan
+Vld
+vm
+Vm
+VM
+vms
+VMs
+VMware
+vnf
+vNF
+Vnf
+VNF
+vnfapi
+vnfc
+VNFFG
+vnfm
+Vnfm
+VNFM
+VNFMs
+vnfs
+vNFs
+vnfsdk
+VPN
+vrouter
+vserver
+vServer
+Vserver
+vservers
+Vservers
+vswitch
+VVP
+Vyatta
+webapp
+webapps
+Webpage
+webserver
+WebServer
+Websocket
+Websockets
+whitebox
+whiteboxes
+whitepaper
+wiki
+Wiki
+Wikis
+Wildfly
+Windriver
+Wireline
+workflow
+Workflow
+workflows
+www
+xml
+Xmx
+Yaml
+yamls
+zabbix
+Zachman
+Zookeeper
+ZTE
diff --git a/etc/requirements.txt b/etc/requirements.txt
index 23b46594a..4b8679121 100644
--- a/etc/requirements.txt
+++ b/etc/requirements.txt
@@ -6,6 +6,7 @@ setuptools
six
sphinx_rtd_theme
sphinxcontrib-blockdiag
+sphinxcontrib-nwdiag
sphinxcontrib-seqdiag
sphinxcontrib-swaggerdoc
sphinxcontrib-plantuml