Skip to content

Commit ecb5bb3

Browse files
author
Larry Peterson
committed
upgraded Sphinx
1 parent 7dc4cbf commit ecb5bb3

File tree

3 files changed

+189
-24
lines changed

3 files changed

+189
-24
lines changed

‎conf.py‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,20 +61,34 @@ def get_version():
6161
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
6262
# ones. ***Replace "mathjax" with "imgmath" for epub output.***
6363
extensions = [
64-
'recommonmark',
6564
'sphinx.ext.coverage',
65+
'sphinx.ext.graphviz',
6666
'sphinx.ext.ifconfig',
67+
'sphinx.ext.intersphinx',
6768
'sphinx.ext.mathjax',
6869
'sphinx.ext.todo',
69-
'sphinx.ext.autosectionlabel',
70-
'sphinxcontrib.actdiag',
71-
'sphinxcontrib.blockdiag',
72-
'sphinxcontrib.nwdiag',
73-
'sphinxcontrib.packetdiag',
74-
'sphinxcontrib.rackdiag',
75-
'sphinxcontrib.seqdiag',
70+
'sphinxcontrib.spelling',
71+
"sphinx_multiversion",
7672
]
7773

74+
#extensions = [
75+
# 'recommonmark',
76+
# 'sphinx.ext.coverage',
77+
# 'sphinx.ext.ifconfig',
78+
# 'sphinx.ext.mathjax',
79+
# 'sphinx.ext.todo',
80+
# 'sphinx.ext.autosectionlabel',
81+
# 'sphinxcontrib.actdiag',
82+
# 'sphinxcontrib.blockdiag',
83+
# 'sphinxcontrib.nwdiag',
84+
# 'sphinxcontrib.packetdiag',
85+
# 'sphinxcontrib.rackdiag',
86+
# 'sphinxcontrib.seqdiag',
87+
#]
88+
89+
# Text files with lists of words that shouldn't fail the spellchecker:
90+
spelling_word_list_filename=['dict.txt', ]
91+
7892
# Add any paths that contain templates here, relative to this directory.
7993
templates_path = ['_templates']
8094

@@ -255,8 +269,8 @@ def get_version():
255269
# -- Configure recommonmark to use AutoStructify -----------------------------
256270
# Docs: https://recommonmark.readthedocs.io/en/latest/auto_structify.html
257271

258-
import recommonmark
259-
from recommonmark.transform import AutoStructify
272+
#import recommonmark
273+
#from recommonmark.transform import AutoStructify
260274

261275
# -- Set up Google Analytics
262276
# -- using approach at https://stackoverflow.com/questions/9444342/adding-a-javascript-script-tag-some-place-so-that-it-works-for-every-file-in-sph/41885884#41885884
@@ -278,7 +292,7 @@ def setup(app):
278292
'auto_toc_tree_section': 'Contents',
279293
}, True)
280294

281-
app.add_transform(AutoStructify)
295+
# app.add_transform(AutoStructify)
282296

283297
app.add_js_file('https://www.googletagmanager.com/gtag/js?id=G-QLSP3FJWGT')
284298
app.add_js_file(None, body=GA_INVOKE_JS)

‎dict.txt‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
ASIC
2+
Acknowledgements
3+
Aether
4+
Amin
5+
Antrea
6+
Arpanet
7+
Atomix
8+
BNG
9+
Broadcom
10+
Cascone
11+
Centric
12+
Comcast
13+
Config
14+
Connor
15+
Ctrl
16+
Davie
17+
Deparser
18+
Disaggregating
19+
École
20+
Feamster
21+
Gbps
22+
IPv
23+
Inband
24+
IntelliJ
25+
IoT
26+
Ipsilon
27+
Kahn
28+
Karaf
29+
Kobayashi
30+
Liu
31+
Makefile
32+
Mcast
33+
Microsegmentation
34+
Milano
35+
Mininet
36+
Montréal
37+
Multicast
38+
Multiprotocol
39+
OCP
40+
Ongaro
41+
Ousterhout
42+
PON
43+
Ph
44+
Pipeconf
45+
Pipeliner
46+
Pipeliners
47+
Pipeliners
48+
Politecnico
49+
Polytechnique
50+
Pudelko
51+
QinQ
52+
QoS
53+
Quagga
54+
Repo
55+
Rexford
56+
Runtime
57+
SAI
58+
SNMP
59+
SRv
60+
Shenker
61+
Stratum
62+
Sunay
63+
Tbps
64+
Telco
65+
Tofino
66+
Trellis
67+
Tseng
68+
Ueno
69+
Univesity
70+
VMware
71+
Vachuska
72+
Vahdat
73+
Veriflow
74+
Xiaoqi
75+
Yi
76+
Zegura
77+
adaptor
78+
adaptors
79+
al
80+
aspirational
81+
backend
82+
backends
83+
backhaul
84+
bmv
85+
centric
86+
checksums
87+
chipset
88+
commoditized
89+
compositional
90+
config
91+
cyber
92+
de
93+
di
94+
decapsulation
95+
decrementing
96+
decrypt
97+
demarking
98+
deparser
99+
directionality
100+
disaggregate
101+
disaggregated
102+
disaggregating
103+
et
104+
ethernet
105+
extern
106+
externs
107+
failover
108+
firewalling
109+
gNMI
110+
gNOI
111+
gNXI
112+
gRPC
113+
handoffs
114+
hyperscale
115+
incrementing
116+
interoperable
117+
intra
118+
judgement
119+
microsegments
120+
microservice
121+
misconfigurations
122+
modularity
123+
multicast
124+
nexthop
125+
orchestrator
126+
parameterizing
127+
pluggable
128+
pre
129+
programmability
130+
programme
131+
protobuf
132+
protobufs
133+
pseudowires
134+
repo
135+
retargeting
136+
roadmap
137+
runtime
138+
sFlow
139+
scalability
140+
subdirectory
141+
subgraph
142+
subnet
143+
syscall
144+
toolchain
145+
toolchains
146+
toolset
147+
transformative
148+
ttl
149+
unicast
150+
utilizations
151+
vSwitch
152+
vSwitches
153+
verifiability
154+
verifiably
155+
virtualized
156+
virtualenv
157+
µONOS
158+

‎requirements.txt‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
1-
Sphinx~=1.8.5
2-
actdiag~=0.5.4
3-
blockdiag~=1.5.4
4-
livereload~=2.6.1
5-
nwdiag~=1.0.4
6-
recommonmark~=0.6.0
7-
rstcheck~=3.3.1
8-
seqdiag~=0.9.6
9-
sphinx-reload~=0.2.0
1+
Sphinx~=3.1.1
2+
doc8~=0.8.0
3+
reuse~=0.11.1
4+
docutils==0.16
105
sphinx-rtd-theme~=0.4.3
11-
sphinxcontrib-actdiag~=0.8.5
12-
sphinxcontrib-blockdiag~=1.5.5
13-
sphinxcontrib-nwdiag~=0.9.5
14-
sphinxcontrib-seqdiag~=0.8.5
6+
sphinxcontrib-spelling~=4.3.0
7+
git+https://github.com/zdw/sphinx-multiversion@ec7c01cdaf2f9241245e84483dfb9bc0d0dffc62

0 commit comments

Comments
 (0)