Skip to content

Commit

Permalink
update apidocs
Browse files Browse the repository at this point in the history
Signed-off-by: vsoch <[email protected]>
  • Loading branch information
vsoch committed Nov 2, 2023
1 parent df13d51 commit dfbf3b5
Show file tree
Hide file tree
Showing 35 changed files with 2,167 additions and 1,251 deletions.
22 changes: 11 additions & 11 deletions apigen/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@
master_doc = "index"

# General information about the project.
project = "Cloud Select"
copyright = "2022, LLNL LLC Converged Computing Contributors"
project = "Flux Burst"
copyright = "2023, LLNL LLC Converged Computing Contributors"
author = "Vanessa Sochat"

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -262,7 +262,7 @@
# html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = "CloudSelect"
htmlhelp_basename = "FluxBurst"

# -- Options for LaTeX output ---------------------------------------------

Expand All @@ -287,8 +287,8 @@
latex_documents = [
(
master_doc,
"CloudSelect.tex",
"Cloud Select API Documentation",
"FluxBurst.tex",
"Flux Burst API Documentation",
"Vanessa Sochat",
"manual",
),
Expand Down Expand Up @@ -334,8 +334,8 @@
man_pages = [
(
master_doc,
"cloud-select",
"Cloud Select API Documentation",
"flux-burst",
"Flux Burst API Documentation",
[author],
1,
)
Expand All @@ -354,11 +354,11 @@
texinfo_documents = [
(
master_doc,
"CloudSelectAPI",
"Cloud Select API Documentation",
"FluxBurstAPI",
"Flux Burst API Documentation",
author,
"CloudSelectAPI",
"Tool to select cloud resources",
"FluxBurstAPI",
"Burst to external resources",
"Miscellaneous",
),
]
Expand Down
24 changes: 23 additions & 1 deletion docs/api/assets/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,10 @@ a.headerlink {
visibility: hidden;
}

a:visited {
color: #551A8B;
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -670,6 +674,16 @@ dd {
margin-left: 30px;
}

.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}

.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}

dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
Expand Down Expand Up @@ -738,6 +752,14 @@ abbr, acronym {
cursor: help;
}

.translated {
background-color: rgba(207, 255, 207, 0.2)
}

.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}

/* -- code displays --------------------------------------------------------- */

pre {
Expand Down Expand Up @@ -900,4 +922,4 @@ div.math:hover a.headerlink {
#top-link {
display: none;
}
}
}
2 changes: 1 addition & 1 deletion docs/api/assets/css/badge_only.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit dfbf3b5

Please sign in to comment.