Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ env/

#Build files
dist
docs
docs/_build/
docs/reference/
docs/_build/json/

#testfile
server.py
Expand Down
22 changes: 22 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

.PHONY: help Makefile html clean

help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

html:
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

json:
@$(SPHINXBUILD) -b json "$(SOURCEDIR)" "$(BUILDDIR)/json" $(SPHINXOPTS) $(O)

clean:
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
rm -rf reference/

%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
263 changes: 263 additions & 0 deletions docs/_static/auth0.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,263 @@
/* ============================================================
Auth0 brand theme for Sphinx / furo
============================================================ */

/* --- Brand colors (light mode) ----------------------------- */
:root {
--color-brand-primary: #9921FE;
--color-brand-content: #9921FE;
--color-api-name: #9921FE;
--color-api-pre-name: #9921FE;
--color-link: #9921FE;
--color-link--hover: #7A10D4;

/* Sidebar: Auth0 dark navy */
--color-sidebar-background: #16214A;
--color-sidebar-background-border: #1e2d5a;
--color-sidebar-brand-text: #FFFFFF;
--color-sidebar-caption-text: rgba(255,255,255,0.5);
--color-sidebar-link-text: rgba(255,255,255,0.82);
--color-sidebar-link-text--top-level: #BC6DFF;
--color-sidebar-item-background--hover: rgba(153,33,254,0.14);
--color-sidebar-item-background--current: rgba(153,33,254,0.22);
--color-sidebar-search-text: #FFFFFF;
--color-sidebar-search-background: rgba(255,255,255,0.06);
--color-sidebar-search-background--focus: rgba(255,255,255,0.10);
--color-sidebar-search-border: rgba(255,255,255,0.14);
--color-sidebar-search-icon: rgba(255,255,255,0.4);
}

/* --- Brand colors (dark mode) ------------------------------ */
body[data-theme="dark"] {
--color-brand-primary: #BC6DFF;
--color-brand-content: #BC6DFF;
--color-api-name: #BC6DFF;
--color-api-pre-name: #BC6DFF;
--color-link: #BC6DFF;
--color-link--hover: #9921FE;
}

/* ============================================================
Typography and spacing
============================================================ */

.content-container {
max-width: 860px;
}

article.bd-article,
div[role="main"] {
line-height: 1.7;
font-size: 1rem;
}

/* Method/class entries: breathe vertically */
dl.py {
margin-bottom: 2.5rem;
}

dl.py + dl.py {
padding-top: 1rem;
border-top: 1px solid var(--color-background-border);
}

/* ============================================================
Method and function signature bars
============================================================ */

dt.sig {
border-left: 4px solid var(--color-brand-primary);
background: var(--color-background-secondary);
padding: 0.6rem 0.9rem;
border-radius: 0 0.4rem 0.4rem 0;
font-size: 0.95rem;
margin-bottom: 0.75rem;
overflow-x: auto;
}

/* Class/function name in signature */
.sig-name.descname {
color: var(--color-brand-primary);
font-weight: 700;
}

/* Mute "async" / "classmethod" / "property" property badges */
em.property {
font-style: normal;
color: var(--color-foreground-secondary);
font-size: 0.82em;
margin-right: 0.25em;
font-weight: 400;
}

/* Class/function body: indent cleanly */
dl.py > dd {
padding-left: 1.25rem;
margin-left: 0;
border-left: 2px solid var(--color-background-border);
padding-top: 0.25rem;
padding-bottom: 0.5rem;
}

/* ============================================================
Pydantic-style parameter blocks
============================================================ */

/* Outer card */
dl.field-list {
border: 1px solid var(--color-background-border);
border-radius: 0.5rem;
overflow: hidden;
margin: 1.25rem 0 1.5rem;
font-size: 0.9rem;
box-shadow: 0 1px 3px rgba(0,0,0,0.05);
}

body[data-theme="dark"] dl.field-list {
box-shadow: none;
}

/* Section labels: "Parameters" / "Returns" / "Raises" */
dl.field-list dt {
background: var(--color-background-secondary);
margin: 0;
padding: 0.4rem 0.9rem;
font-size: 0.7rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.08em;
color: var(--color-foreground-secondary);
border-bottom: 1px solid var(--color-background-border);
}

/* Separator between adjacent sections */
dl.field-list dd + dt {
border-top: 1px solid var(--color-background-border);
}

/* Hide the rendered colon after labels */
dl.field-list dt .colon { display: none; }

/* Content area */
dl.field-list dd {
margin: 0;
padding: 0;
}

/* Single-entry Returns / Raises */
dl.field-list dd > p {
margin: 0;
padding: 0.55rem 0.9rem;
line-height: 1.6;
}

/* Multi-parameter list */
dl.field-list dd > ul.simple {
list-style: none;
padding: 0;
margin: 0;
}

/* Individual parameter row */
dl.field-list dd > ul.simple > li {
border-bottom: 1px solid var(--color-background-border);
padding: 0.55rem 0.9rem;
line-height: 1.6;
}

dl.field-list dd > ul.simple > li:last-child {
border-bottom: none;
}

dl.field-list dd > ul.simple > li > p {
margin: 0;
}

/* Parameter name: monospace, brand purple */
dl.field-list strong {
font-family: var(--font-stack--monospace);
color: var(--color-brand-primary);
font-size: 0.92em;
font-weight: 600;
}

/* Type annotation: smaller, muted */
dl.field-list em {
font-style: normal;
font-size: 0.86em;
color: var(--color-foreground-secondary);
}

/* ============================================================
Attribute entries (class fields)
============================================================ */

dl.py.attribute > dt.sig {
border-left-color: #7B8CCC; /* softer blue-purple for attributes vs methods */
}

dl.py.attribute > dd {
color: var(--color-foreground-secondary);
font-size: 0.93rem;
padding-top: 0.3rem;
}

/* ============================================================
Inline code and code blocks
============================================================ */

code.docutils.literal {
background: var(--color-background-secondary);
border: 1px solid var(--color-background-border);
padding: 0.1em 0.35em;
border-radius: 3px;
font-size: 0.9em;
}

pre {
border-radius: 0.5rem;
font-size: 0.88rem;
line-height: 1.6;
}

/* ============================================================
Section headings
============================================================ */

h1 {
font-size: 1.9rem;
font-weight: 700;
border-bottom: 3px solid var(--color-brand-primary);
padding-bottom: 0.4rem;
margin-bottom: 1.25rem;
}

h2 {
font-size: 1.35rem;
font-weight: 600;
border-bottom: 1px solid var(--color-background-border);
padding-bottom: 0.3rem;
margin-top: 2rem;
margin-bottom: 1rem;
}

h3 {
font-size: 1.1rem;
font-weight: 600;
color: var(--color-foreground-secondary);
margin-top: 1.5rem;
}

/* ============================================================
Admonitions (note, warning, etc.)
============================================================ */

div.admonition {
border-radius: 0.45rem;
border-left-width: 4px;
padding: 0.75rem 1rem;
}

div.admonition.note {
border-left-color: var(--color-brand-primary);
}
Loading
Loading