Skip to content

Commit df69681

Browse files
zachcamara-hpezachcamara-hpe
committed
Merge branch 'docs/rtd_update' into development
2 parents 46d0335 + 12be2ac commit df69681

8 files changed

Lines changed: 167 additions & 14 deletions

File tree

‎docs/source/_static/aruba_small_use_logo.png‎

23.3 KB
Loading

‎docs/source/_static/css/pyedgeconnect.css‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
/* Nav Search Background */
2+
.wy-side-nav-search {
3+
background-color: #FF8300
4+
}
5+
6+
.wy-side-nav-search .wy-dropdown>a img.logo,
7+
.wy-side-nav-search>a img.logo {
8+
width: 125px;
9+
}
10+
11+
/* Menu Title Color */
12+
.wy-menu-vertical p.caption {
13+
color: #FF8300;
14+
}
15+
16+
/* Content background */
17+
.wy-nav-content {
18+
margin: 0;
19+
background: #0F3250;
20+
}
21+
22+
/* Outer background */
23+
.wy-nav-content-wrap {
24+
background: #343131;
25+
}
26+
27+
/* Body Text Color */
28+
body {
29+
color: #dbdce1;
30+
}
31+
32+
dd {
33+
display: block;
34+
margin-inline-start: 0px;
35+
}
36+
37+
/* Header Text Color */
38+
.rst-content .toctree-wrapper>p.caption,
39+
h1,
40+
h2,
41+
h3,
42+
h4,
43+
h5,
44+
h6,
45+
legend {
46+
color: #FFFFFF;
47+
}
48+
49+
/* Notes, Warnings, Important Colors */
50+
.rst-content .note .admonition-title {
51+
background: rgba(53, 139, 193, 1)
52+
}
53+
54+
.rst-content .note {
55+
background: rgba(53, 139, 193, 0.5)
56+
}
57+
58+
.rst-content .warning .admonition-title {
59+
background: rgba(193, 53, 53, 1)
60+
}
61+
62+
.rst-content .warning {
63+
background: rgba(193, 53, 53, 0.5)
64+
}
65+
66+
.rst-content .important .admonition-title {
67+
background: rgba(255, 131, 0, 1)
68+
}
69+
70+
.rst-content .important {
71+
background: rgba(255, 131, 0, 0.7)
72+
}
73+
74+
75+
/* Code Highlight */
76+
.highlight {
77+
color: #ADE1F0;
78+
background: #04121e;
79+
}
80+
81+
.highlight .s1 {
82+
color: #FF8300;
83+
}
84+
85+
.highlight .s2 {
86+
color: #FF8300;
87+
}
88+
89+
.highlight .sd {
90+
color: #FF8300;
91+
}
92+
93+
.rst-content div[class^=highlight],
94+
.rst-content pre.literal-block {
95+
border: none
96+
}
97+
98+
99+
.rst-content code.literal,
100+
.rst-content tt.literal {
101+
color: #ADE1F0;
102+
background: #04121e;
103+
border: none;
104+
}
105+
106+
.rst-content code.xref,
107+
.rst-content tt.xref,
108+
a .rst-content code,
109+
a .rst-content tt {
110+
font-weight: 900;
111+
}
112+
113+
114+
/* Table Text */
115+
.rst-content table.docutils caption,
116+
.rst-content table.field-list caption,
117+
.wy-table caption {
118+
color: #ADE1F0;
119+
}
120+
121+
.rst-content table.docutils thead,
122+
.rst-content table.field-list thead,
123+
.wy-table thead {
124+
color: #ADE1F0;
125+
}
126+
127+
.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,
128+
.wy-table-backed,
129+
.wy-table-odd td,
130+
.wy-table-striped tr:nth-child(2n-1) td {
131+
background-color: #184369;
132+
}
133+
134+
/* Module Content */
135+
136+
html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descname,
137+
html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .sig-name {
138+
color: #0F3250;
139+
}
140+
141+
strong {
142+
color: #ADE1F0;
143+
}

‎docs/source/conf.py‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Configuration file for the Sphinx documentation builder.
2-
#
2+
33
import os
44
import sys
55

@@ -16,15 +16,20 @@
1616
# Main version number
1717
version = "0.15"
1818
# The full version, including alpha/beta/rc tags
19-
release = "0.15.2-a1"
19+
release = "0.15.3-a1"
2020

2121

2222
# -- General configuration ---------------------------------------------------
2323

2424
# Add any Sphinx extension module names here, as strings. They can be
2525
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2626
# ones.
27-
extensions = ["sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.autodoc"]
27+
extensions = [
28+
"sphinx.ext.todo",
29+
"sphinx.ext.viewcode",
30+
"sphinx.ext.autodoc",
31+
"sphinx.ext.viewcode",
32+
]
2833

2934
# Add any paths that contain templates here, relative to this directory.
3035
templates_path = ["_templates"]
@@ -40,10 +45,15 @@
4045
# The theme to use for HTML and HTML Help pages. See the documentation for
4146
# a list of builtin themes.
4247
#
43-
# html_theme = 'alabaster'
4448
html_theme = "sphinx_rtd_theme"
49+
html_logo = "_static/aruba_small_use_logo.png"
50+
4551

4652
# Add any paths that contain custom static files (such as style sheets) here,
4753
# relative to this directory. They are copied after the builtin static files,
4854
# so a file named "default.css" will overwrite the builtin "default.css".
4955
html_static_path = ["_static"]
56+
57+
58+
def setup(app):
59+
app.add_css_file("css/pyedgeconnect.css")

‎docs/source/examples/auth_example.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. auth_example:
22
3-
============================
4-
Authentication
5-
============================
3+
4+
Authentication
5+
********************************
66

77
The following code snippet is an example of handling multiple authentication
88
methods when connecting to an Aruba Orchestrator instance with pyedgeconnect.

‎docs/source/examples/basic_examples.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
1818
1919
Print Appliance Information
20-
===========================
20+
------------------------------
2121

2222
This example retrieves all the appliances currently in Orchestrator
2323
and then prints the appliances and certain attributes into a table in
@@ -89,7 +89,7 @@ the terminal output.
8989
9090
9191
Run Packet Capture
92-
==================
92+
-----------------------
9393

9494
This example will run a tcpdump packet capture on the specified
9595
appliance and then upload the file to Orchestrator so that it can be
@@ -158,8 +158,8 @@ downloaded by the user or uploaded to support.
158158
pass
159159
160160
161-
Create User
162-
==================
161+
Create Local Orchestrator User
162+
--------------------------------
163163

164164
This example will create a new user read-only user
165165
locally on Orchestrator.

‎docs/source/examples/generate_preconfig.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
2525
2626
Generate EdgeConnect Preconfig
27-
------------------------------
27+
********************************
2828

2929
This example uses a Jinja template to generate the YAML text for an
3030
EdgeConnect preconfig. The YAML preconfig allows for an appliance to be

‎docs/source/examples/upload_security_policy.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
3131
3232
Upload EdgeConnect Security Policy
33-
----------------------------------
33+
************************************
3434

3535
This example uses a CSV file as source data to generate a security
3636
policy for EdgeConnect. The security policy can be uploaded to a net-new

‎pyedgeconnect/orch/_action_log.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def get_audit_log(
6060
the action in milliseconds since epoch
6161
* keyword **percentComplete** (`int`): Percentage completion
6262
of the action
63-
* keyword **completionStatus** (boolean): Show if action
63+
* keyword **completionStatus** (`bool`): Show if action
6464
succeeded or failed
6565
* keyword **result** (`str`): Opaque blob of data related to
6666
action. Typically, this is the result of the action.

0 commit comments

Comments
 (0)