Implement preflight checks
- spellcheck - linkcheck Implemented as distinct environments to prevent premature exits on error. Add 'enchant' C library via bindep Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I61912b7601719649655dd9dae86800f8b33d58f8
This commit is contained in:
Ron Stone
parent
071eab20c1
commit
7271e6bc45
|
|
@ -0,0 +1 @@
|
|||
enchant-2 [doc]
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
sphinx==4.2.0
|
||||
openstackdocstheme>=2.2.1,<=2.3.1 # Apache-2.0
|
||||
sphinxcontrib-spelling==7.3.2
|
||||
|
||||
# API Reference Guide
|
||||
os-api-ref>=1.5.0 # Apache-2.0
|
||||
|
|
|
|||
|
|
@ -36,6 +36,7 @@ author = 'StarlingX'
|
|||
# ones.
|
||||
extensions = [
|
||||
# 'openstackdocstheme',
|
||||
'sphinxcontrib.spelling',
|
||||
'starlingxdocs_plus'
|
||||
]
|
||||
|
||||
|
|
@ -58,6 +59,8 @@ master_doc = 'index'
|
|||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
spelling_word_list_filename='spelling_wordlist.txt'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path .
|
||||
|
|
|
|||
|
|
@ -0,0 +1,763 @@
|
|||
µs
|
||||
accessMode
|
||||
acmesolver
|
||||
addon
|
||||
addrpool
|
||||
AIO
|
||||
AlarmID
|
||||
AlarmSeverity
|
||||
allowMultiplePerNode
|
||||
analytics
|
||||
ansible
|
||||
Ansible
|
||||
aodh
|
||||
Aodh
|
||||
api
|
||||
apiGroups
|
||||
apis
|
||||
apiserver
|
||||
apparmor
|
||||
appname
|
||||
ata
|
||||
atch
|
||||
attrs
|
||||
auditable
|
||||
Auditd
|
||||
authNoPriv
|
||||
authPriv
|
||||
autoboot
|
||||
autoscale
|
||||
autoscaler
|
||||
Autoscaler
|
||||
autoscaling
|
||||
autounseal
|
||||
awk
|
||||
backend
|
||||
Backend
|
||||
backends
|
||||
Backends
|
||||
backendType
|
||||
backported
|
||||
baseband
|
||||
billingDeptGroup
|
||||
bindDN
|
||||
bindep
|
||||
bindPW
|
||||
bitbake
|
||||
Bitbake
|
||||
bitstream
|
||||
blkin
|
||||
blockchain
|
||||
bmc
|
||||
boolean
|
||||
bootable
|
||||
Bootable
|
||||
bootimage
|
||||
bootloader
|
||||
Broadcom
|
||||
bulleted
|
||||
Burstable
|
||||
busybox
|
||||
caCert
|
||||
calc
|
||||
cengn
|
||||
centos
|
||||
ceph
|
||||
Ceph
|
||||
cephfs
|
||||
cephx
|
||||
certifcate
|
||||
certtype
|
||||
cgroup
|
||||
cgroups
|
||||
cgts
|
||||
chipset
|
||||
chrony
|
||||
chronyd
|
||||
cli
|
||||
CLI
|
||||
Cloudification
|
||||
clusterissuer
|
||||
clusterrole
|
||||
cmdline
|
||||
CN
|
||||
codebase
|
||||
coldStart
|
||||
Coleto
|
||||
collectd
|
||||
Columbiaville
|
||||
commandline
|
||||
config
|
||||
Config
|
||||
configmap
|
||||
configmaps
|
||||
configs
|
||||
ConnectX
|
||||
containerd
|
||||
Containerd
|
||||
controllerstorage
|
||||
coredns
|
||||
Coredns
|
||||
CoW
|
||||
cpio
|
||||
cpu
|
||||
cpuinfo
|
||||
cpus
|
||||
cpuset
|
||||
cpuX
|
||||
cqn
|
||||
cri
|
||||
cron
|
||||
cronjob
|
||||
cronSchedule
|
||||
crushmap
|
||||
crypto
|
||||
csi
|
||||
csr
|
||||
cutover
|
||||
cyber
|
||||
Cygwin
|
||||
daemonset
|
||||
Daemonsets
|
||||
daemonsets
|
||||
datafile
|
||||
datanet
|
||||
datanetwork
|
||||
datanetworks
|
||||
datanetworkUUID
|
||||
DateAndTime
|
||||
dbmon
|
||||
dcdbsync
|
||||
dcmanager
|
||||
dcorch
|
||||
dedicatedstorage
|
||||
deprovision
|
||||
Deprovision
|
||||
deprovisioned
|
||||
deprovisioning
|
||||
dev
|
||||
Dev
|
||||
devtoolset
|
||||
dex
|
||||
Dex
|
||||
distcloud
|
||||
distro
|
||||
Distro
|
||||
distros
|
||||
DL
|
||||
dns
|
||||
dockerfile
|
||||
Dockerfile
|
||||
dpdk
|
||||
dpdkBasebandDevice
|
||||
dracut
|
||||
DRBD
|
||||
dropdown
|
||||
eASIC
|
||||
ebtables
|
||||
edgeworker
|
||||
Edgeworker
|
||||
edgeworker
|
||||
Edgeworkers
|
||||
EF
|
||||
efi
|
||||
EFI
|
||||
Emulex
|
||||
enablement
|
||||
engineID
|
||||
enp
|
||||
EntityInstanceID
|
||||
env
|
||||
etcd
|
||||
Etcd
|
||||
EtcdCA
|
||||
EtcdRootCA
|
||||
etf
|
||||
eth
|
||||
ethernet
|
||||
EventID
|
||||
EventSeverity
|
||||
EventType
|
||||
examplex
|
||||
eXtensible
|
||||
facto
|
||||
failover
|
||||
failsafe
|
||||
fb
|
||||
fcae
|
||||
fcd
|
||||
fd
|
||||
fieldname
|
||||
fileName
|
||||
filepath
|
||||
filestore
|
||||
filesystem
|
||||
Filesystem
|
||||
filesystems
|
||||
Filesystems
|
||||
filesystems
|
||||
Fortville
|
||||
fqdn
|
||||
Freerun
|
||||
fsid
|
||||
fullnameOverride
|
||||
gapped
|
||||
Gb
|
||||
GBytes
|
||||
gcr
|
||||
getaffinity
|
||||
GiB
|
||||
github
|
||||
globalnetworkpolicy
|
||||
gnp
|
||||
gpt
|
||||
gPTP
|
||||
gpu
|
||||
grubx
|
||||
guestmount
|
||||
guestunmount
|
||||
gui
|
||||
hardcode
|
||||
hardcoded
|
||||
hexidecimal
|
||||
hieradata
|
||||
hostname
|
||||
Hostname
|
||||
hostnames
|
||||
hostwd
|
||||
hpa
|
||||
http
|
||||
https
|
||||
hugepage
|
||||
hugepages
|
||||
Hugepages
|
||||
hyperthreading
|
||||
Hyperthreading
|
||||
hyperthreads
|
||||
hypervisor
|
||||
hypervisors
|
||||
IaaS
|
||||
icmp
|
||||
icr
|
||||
IDentity
|
||||
idisk
|
||||
ifclass
|
||||
ifname
|
||||
IIoT
|
||||
iLO
|
||||
ImagePolicy
|
||||
imagePullSecret
|
||||
implantisomd
|
||||
initrd
|
||||
inprogress
|
||||
insync
|
||||
integ
|
||||
intel
|
||||
intermediateCA
|
||||
intnet
|
||||
IoT
|
||||
iov
|
||||
ip
|
||||
iptables
|
||||
IPv
|
||||
ipVersion
|
||||
iPXE
|
||||
iso
|
||||
isohybrid
|
||||
isolcpus
|
||||
javascript
|
||||
jetstack
|
||||
kata
|
||||
Kata
|
||||
keypairs
|
||||
keystoneUserName
|
||||
KiB
|
||||
Kontron
|
||||
kuard
|
||||
kube
|
||||
kubeadm
|
||||
kubeconfig
|
||||
kubectl
|
||||
kubelet
|
||||
kubelets
|
||||
Kubelets
|
||||
kubernetes
|
||||
Kubernetes
|
||||
kubesystem
|
||||
kustomize
|
||||
kvm
|
||||
libnetwork
|
||||
Libnetwork
|
||||
libvirt
|
||||
lifecycle
|
||||
Lifecycle
|
||||
linters
|
||||
linux
|
||||
linuxptp
|
||||
Liveness
|
||||
loadbuild
|
||||
localdisk
|
||||
localhost
|
||||
localrc
|
||||
logrotate
|
||||
loopback
|
||||
losetup
|
||||
lowlatency
|
||||
lst
|
||||
lvm
|
||||
lvmthinpool
|
||||
macOS
|
||||
makefile
|
||||
managerGroup
|
||||
mariadb
|
||||
Mariadb
|
||||
Mbps
|
||||
Mellanox
|
||||
Memcached
|
||||
mgmt
|
||||
Mgmt
|
||||
mib
|
||||
MiB
|
||||
mins
|
||||
mitigations
|
||||
mkisofs
|
||||
mktemp
|
||||
mnfa
|
||||
mnt
|
||||
mockchain
|
||||
monmap
|
||||
monstore
|
||||
motd
|
||||
mountpoint
|
||||
mqprio
|
||||
msec
|
||||
mtcAgent
|
||||
mtu
|
||||
multicast
|
||||
Multicast
|
||||
multichassis
|
||||
multus
|
||||
myApplication
|
||||
mycompany
|
||||
mydomain
|
||||
nameservers
|
||||
namespace
|
||||
Namespace
|
||||
namespaced
|
||||
namespaces
|
||||
Namespaces
|
||||
netapp
|
||||
Netapp
|
||||
Netapps
|
||||
netboot
|
||||
netdevice
|
||||
netmask
|
||||
nEtw
|
||||
Netw
|
||||
networktype
|
||||
newnote
|
||||
nfd
|
||||
nfv
|
||||
nginx
|
||||
Nginx
|
||||
Niantic
|
||||
NIC
|
||||
nn
|
||||
NodePort
|
||||
nodeSelector
|
||||
novncproxy
|
||||
ntfs
|
||||
ntp
|
||||
ntpd
|
||||
ntpservers
|
||||
numa
|
||||
numvfs
|
||||
nvidia
|
||||
nvme
|
||||
oam
|
||||
OAM
|
||||
oam
|
||||
OCI
|
||||
oidc
|
||||
Oidc
|
||||
ok
|
||||
onboard
|
||||
Onboard
|
||||
oneAPI
|
||||
onwards
|
||||
opendev
|
||||
openflow
|
||||
Openflow
|
||||
openrc
|
||||
Openssh
|
||||
openssl
|
||||
openstack
|
||||
Openstack
|
||||
openstack
|
||||
openstackclients
|
||||
osd
|
||||
overrideable
|
||||
ovs
|
||||
ovverrides
|
||||
panko
|
||||
Panko
|
||||
Paravirtualized
|
||||
passhtru
|
||||
passthrough
|
||||
Passthrough
|
||||
pci
|
||||
PCI
|
||||
pciaddress
|
||||
pcnet
|
||||
PCnet
|
||||
peergroup
|
||||
pem
|
||||
persistentvolume
|
||||
persistentVolumeClaims
|
||||
pgp
|
||||
pgs
|
||||
phc
|
||||
pids
|
||||
pkgs
|
||||
Pkgs
|
||||
platformclients
|
||||
playbookconfig
|
||||
pmon
|
||||
pmond
|
||||
pnet
|
||||
podAntiAffinity
|
||||
portieris
|
||||
Portieris
|
||||
portState
|
||||
postgres
|
||||
Postgres
|
||||
Postgresql
|
||||
postrequisites
|
||||
Postrequisites
|
||||
poweroff
|
||||
Powerville
|
||||
Pre
|
||||
pre
|
||||
preconfigured
|
||||
prepended
|
||||
prepends
|
||||
prestage
|
||||
Prestage
|
||||
prestaged
|
||||
Prestaged
|
||||
Prestages
|
||||
prestaging
|
||||
Prestaging
|
||||
prestart
|
||||
ProbableCause
|
||||
processname
|
||||
project
|
||||
ProposedRepairAction
|
||||
Proto
|
||||
providernet
|
||||
provisoner
|
||||
provsioner
|
||||
pruposes
|
||||
psp
|
||||
ptp
|
||||
ptptracking
|
||||
pv
|
||||
pvc
|
||||
pxe
|
||||
pxeboot
|
||||
Pxeboot
|
||||
pxebooting
|
||||
pxelinux
|
||||
py
|
||||
qat
|
||||
Qav
|
||||
Qbv
|
||||
qcow
|
||||
qdisc
|
||||
qdiscs
|
||||
qemu
|
||||
qos
|
||||
QoS
|
||||
querier
|
||||
Quickstart
|
||||
rabbitmq
|
||||
Rabbitmq
|
||||
rados
|
||||
Rados
|
||||
ramdisk
|
||||
rbd
|
||||
rc
|
||||
rdparties
|
||||
readded
|
||||
README
|
||||
readonly
|
||||
Realtek
|
||||
ReasonText
|
||||
rebase
|
||||
reconfig
|
||||
redirectURIs
|
||||
redis
|
||||
rehome
|
||||
Rehome
|
||||
rehomed
|
||||
rehoming
|
||||
Rehoming
|
||||
rehoming
|
||||
reinstallation
|
||||
Reinstallation
|
||||
reinstallations
|
||||
Rendevous
|
||||
reno
|
||||
replicaCount
|
||||
replicaSet
|
||||
ReplicaSets
|
||||
repo
|
||||
Repo
|
||||
REPO
|
||||
repo
|
||||
Repo
|
||||
repo
|
||||
repos
|
||||
reprovision
|
||||
reprovisioning
|
||||
repulled
|
||||
resizable
|
||||
resourceName
|
||||
restapi
|
||||
reStructuredText
|
||||
retestneeded
|
||||
retimer
|
||||
Retimer
|
||||
rgw
|
||||
rk
|
||||
RK
|
||||
rmdir
|
||||
rolebindings
|
||||
RoleBindings
|
||||
rookstorage
|
||||
rootca
|
||||
rootfs
|
||||
Rootfs
|
||||
rootkey
|
||||
rpc
|
||||
rpmbuild
|
||||
rpms
|
||||
rst
|
||||
rST
|
||||
rsync
|
||||
rtl
|
||||
runc
|
||||
runlevel
|
||||
runlevels
|
||||
runtime
|
||||
Runtime
|
||||
runtimes
|
||||
rvmc
|
||||
Salesforce
|
||||
sampleimage
|
||||
sbin
|
||||
sched
|
||||
schemas
|
||||
sda
|
||||
sdb
|
||||
sdc
|
||||
secureboot
|
||||
sed
|
||||
selectwhich
|
||||
sensorname
|
||||
seperated
|
||||
serviceAccount
|
||||
serviceaccount
|
||||
serviceaccounts
|
||||
serviceAccounts
|
||||
ServiceAffecting
|
||||
severities
|
||||
snmp
|
||||
SNMP
|
||||
snmp
|
||||
snmpd
|
||||
specfile
|
||||
spectre
|
||||
Spectre
|
||||
spectre
|
||||
Springville
|
||||
src
|
||||
Src
|
||||
sriov
|
||||
sRootCA
|
||||
srpm
|
||||
srpms
|
||||
SSD
|
||||
ssl
|
||||
starlingx
|
||||
Starlingx
|
||||
StarlingX
|
||||
statefulset
|
||||
staticClients
|
||||
stdout
|
||||
storages
|
||||
stx
|
||||
Stx
|
||||
STX
|
||||
stx
|
||||
|
||||
Subcloud
|
||||
subcloud
|
||||
subclouds
|
||||
Subclouds
|
||||
subcommand
|
||||
subcommands
|
||||
Subcommands
|
||||
subfunctions
|
||||
subgit
|
||||
subinterface
|
||||
subnet
|
||||
Subnet
|
||||
subnetpool
|
||||
subnets
|
||||
Subnets
|
||||
sudo
|
||||
sudoers
|
||||
SuppressionAllowed
|
||||
svc
|
||||
sw
|
||||
swact
|
||||
Swact
|
||||
Swacted
|
||||
swacting
|
||||
Swacting
|
||||
Swacts
|
||||
SX
|
||||
Symkloud
|
||||
symlink
|
||||
symlinks
|
||||
synching
|
||||
sys
|
||||
sysinv
|
||||
Sysinv
|
||||
syslog
|
||||
systemController
|
||||
systemctl
|
||||
systemd
|
||||
Systemd
|
||||
taprio
|
||||
tcp
|
||||
telecom
|
||||
templated
|
||||
templating
|
||||
testmac
|
||||
testuser
|
||||
tftp
|
||||
tftpboot
|
||||
tgz
|
||||
Thr
|
||||
tiering
|
||||
tiername
|
||||
timestamping
|
||||
timeTraceable
|
||||
tls
|
||||
TLS
|
||||
tmp
|
||||
toml
|
||||
Triaged
|
||||
triaged
|
||||
triages
|
||||
triaging
|
||||
trustServer
|
||||
TSN
|
||||
tty
|
||||
tx
|
||||
Tx
|
||||
tx
|
||||
txt
|
||||
udisksctl
|
||||
udp
|
||||
uio
|
||||
umount
|
||||
unconfigured
|
||||
Uncore
|
||||
unicast
|
||||
Unicast
|
||||
unicasted
|
||||
unixPermissions
|
||||
Unmanage
|
||||
unmanaged
|
||||
Unmanaged
|
||||
unmanaged
|
||||
unmanaging
|
||||
Unmount
|
||||
unmounting
|
||||
Unpause
|
||||
unreferenced
|
||||
unsuppress
|
||||
Unsuppress
|
||||
unsuppressing
|
||||
untrusted
|
||||
uptime
|
||||
upversion
|
||||
Upversion
|
||||
upversioned
|
||||
uri
|
||||
Url
|
||||
url
|
||||
urls
|
||||
useradd
|
||||
userid
|
||||
userspace
|
||||
usr
|
||||
Ussuri
|
||||
uuid
|
||||
varbind
|
||||
varbinds
|
||||
vdi
|
||||
Venafi
|
||||
vf
|
||||
vfio
|
||||
Vfio
|
||||
vfio
|
||||
vfor
|
||||
vg
|
||||
vhost
|
||||
Vhost
|
||||
Vid
|
||||
Vids
|
||||
virsh
|
||||
virt
|
||||
virtio
|
||||
Virtio
|
||||
virtualized
|
||||
vlan
|
||||
Vlan
|
||||
vNIC
|
||||
vNICs
|
||||
volumegroup
|
||||
volumev
|
||||
vPC
|
||||
vRAN
|
||||
vswitch
|
||||
vSwitch
|
||||
VTx
|
||||
vxlan
|
||||
wadcert
|
||||
warmStart
|
||||
webhook
|
||||
Webhook
|
||||
webserver
|
||||
Webserver
|
||||
wget
|
||||
windriver
|
||||
winpty
|
||||
wipedisk
|
||||
wrcprc
|
||||
www
|
||||
xcc
|
||||
xd
|
||||
Xeon
|
||||
xmit
|
||||
xml
|
||||
XOR'd
|
||||
yaml
|
||||
yml
|
||||
yums
|
||||
zoneinfo
|
||||
zuul
|
||||
14
tox.ini
14
tox.ini
|
|
@ -47,3 +47,17 @@ commands =
|
|||
bash new-topic.sh {env:PWD} {toxinidir}
|
||||
whitelist_externals = new-topic.sh
|
||||
bash
|
||||
|
||||
[testenv:linkcheck]
|
||||
deps =
|
||||
-r{toxinidir}/doc/requirements.txt
|
||||
commands =
|
||||
sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -b linkcheck doc/source doc/build/linkcheck {posargs}
|
||||
|
||||
|
||||
[testenv:spellcheck]
|
||||
deps =
|
||||
-r{toxinidir}/doc/requirements.txt
|
||||
commands =
|
||||
sphinx-build -a -E -W --keep-going -d doc/build/doctrees -t starlingx -t openstack -b spelling doc/source doc/build/spelling {posargs}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue