Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
Added sphinx documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
daminton committed Dec 19, 2023
1 parent e4cfdf8 commit e560451
Show file tree
Hide file tree
Showing 26 changed files with 3,206 additions and 44 deletions.
16 changes: 12 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,18 @@ _dependencies


#Documentation
!mkdocs.yml
!docs/*
!docs/*/*
!docs/*/*/*
!.readthedocs.yaml
!docs/
!docs/**/*
docs/**/*.ai
docs/_build/
docs/_build/**/*
docs/generated/
docs/generated/**/*
docs/**/*.DS_Store
docs/**/*.swp


!README_figs/*

#Docker and Singularity files
Expand Down
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
226 changes: 226 additions & 0 deletions docs/_static/index_api_reference.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_static/index_contribute.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
571 changes: 571 additions & 0 deletions docs/_static/index_getting_started.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
606 changes: 606 additions & 0 deletions docs/_static/index_user_guide.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/logos/swiftest_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
512 changes: 512 additions & 0 deletions docs/_static/logos/swiftest_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/logos/swiftest_social_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
572 changes: 572 additions & 0 deletions docs/_static/logos/swiftest_social_preview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
316 changes: 316 additions & 0 deletions docs/_static/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,316 @@
table.colwidths-given {
table-layout: fixed;
width: 100%;
}
table.docutils td {
white-space: unset;
word-wrap: break-word;
}

div.bd-header-announcement {
background-color: unset;
color: #000;
}

/* Reduce left and right margins */

.container, .container-lg, .container-md, .container-sm, .container-xl {
max-width: 1350px !important;
}

/* The following was found at https://stackoverflow.com/a/77588233 */

/* -- .bd-container and .bd-container__inner both need to adjust ---------- */
/* -- this so 'outer container' grows with browser (no L/R 'dead space') -- */
.bd-container {
max-width: 99%;
}

/* -- this so the 'inner container' fills the outer container -------------- */
.bd-container .bd-container__inner {
max-width: 99%;
}

/* -- .bd-article-container holds the "text in the middle" (notebook / md) ------ */
/* -- width is as high as as 100 "ems" (characters) wide, scales with font size -*/
.bd-main .bd-content .bd-article-container {
max-width: 100em;
}


/* Copied from
https://github.com/bokeh/bokeh/blob/branch-2.4/sphinx/source/bokeh/static/custom.css
*/

:root {
/* Logo image height + all the paddings/margins make the navbar height. */
--navbar-height: calc(30px + 0.3125rem * 2 + 0.5rem * 2);
}

.bd-search {
position: relative;
padding-bottom: 20px;
}

@media (min-width: 768px) {
.search-front-page {
width: 50%;
}
}

/* minimal copy paste from bootstrap docs css to get sidebars working */

.bd-toc {
-ms-flex-order: 2;
order: 2;
padding-top: 1.5rem;
padding-bottom: 1.5rem;
/* font-size: 0.875rem; */
/* add scrolling sidebar */
height: calc(100vh - 2rem);
overflow-y: auto;
}

@supports ((position: -webkit-sticky) or (position: sticky)) {
.bd-toc {
position: -webkit-sticky;
position: sticky;
top: 4rem;
height: calc(100vh - 4rem);
overflow-y: auto;
}
}

.section-nav {
padding-left: 0;
border-left: 1px solid #eee;
border-bottom: none;
}

.section-nav ul {
padding-left: 1rem;
}

.toc-entry {
display: block;
}

.toc-entry a {
display: block;
padding: 0.125rem 1.5rem;
color: #77757a;
}

.toc-entry a:hover {
color: rgba(0, 0, 0, 0.85);
text-decoration: none;
}

.bd-sidebar {
-ms-flex-order: 0;
order: 0;
border-bottom: 1px solid rgba(0, 0, 0, 0.1);
}

@media (min-width: 768px) {
.bd-sidebar {
border-right: 1px solid rgba(0, 0, 0, 0.1);
}
@supports ((position: -webkit-sticky) or (position: sticky)) {
.bd-sidebar {
position: -webkit-sticky;
position: sticky;
top: var(--navbar-height);
z-index: 1000;
height: calc(100vh - var(--navbar-height));
}
}
}

@media (min-width: 1200px) {
.bd-sidebar {
-ms-flex: 0 1 480px;
flex: 0 1 480px;
}
}

.bd-links {
padding-top: 1rem;
padding-bottom: 1rem;
margin-right: -15px;
margin-left: -15px;
}

@media (min-width: 768px) {
@supports ((position: -webkit-sticky) or (position: sticky)) {
.bd-links {
max-height: calc(100vh - 9rem);
overflow-y: auto;
}
}
}

@media (min-width: 768px) {
.bd-links {
display: block !important;
}
}

.bd-sidenav {
display: none;
}

.bd-toc-link {
display: block;
padding: 0.25rem 1.5rem;
font-weight: 400;
color: rgba(0, 0, 0, 0.65);
}

.bd-toc-link:hover {
color: rgba(0, 0, 0, 0.85);
text-decoration: none;
}

.bd-toc-item.active {
margin-bottom: 1rem;
}

.bd-toc-item.active:not(:first-child) {
margin-top: 1rem;
}

.bd-toc-item.active > .bd-toc-link {
color: rgba(0, 0, 0, 0.85);
}

.bd-toc-item.active > .bd-toc-link:hover {
background-color: transparent;
}

.bd-toc-item.active > .bd-sidenav {
display: block;
}

.bd-sidebar .nav > li > a {
display: block;
padding: 0.25rem 1.5rem;
font-size: 90%;
}

.bd-sidebar .nav > li > a:hover {
text-decoration: none;
background-color: transparent;
}

.bd-sidebar .nav > .active > a,
.bd-sidebar .nav > .active:hover > a {
font-weight: 400;
/* adjusted from original
color: rgba(0, 0, 0, 0.85);
background-color: transparent; */
}

.bd-sidebar .nav > li > ul {
list-style: none;
padding: 0.25rem 1.5rem;
}

.bd-sidebar .nav > li > ul > li > a {
display: block;
padding: 0.25rem 1.5rem;
font-size: 90%;
}

.bd-sidebar .nav > li > ul > .active > a,
.bd-sidebar .nav > li > ul > .active:hover > a {
font-weight: 400;
}

dt:target {
background-color: initial;
}

/* Offsetting anchored elements within the main content to adjust for fixed header
https://github.com/pandas-dev/pandas-sphinx-theme/issues/6 */
main *:target::before {
display: block;
content: '';
height: var(--navbar-height);
margin-top: calc(-1 * var(--navbar-height));
}

body {
/* Add padding to body to avoid overlap with navbar. */
padding-top: var(--navbar-height);
width: 100%;
}

/* adjust toc font sizes to improve overview */
.toc-h2 {
font-size: 0.85rem;
}

.toc-h3 {
font-size: 0.75rem;
}

.toc-h4 {
font-size: 0.65rem;
}

.toc-entry > .nav-link.active {
font-weight: 400;
color: #314254;
background-color: transparent;
border-left: 2px solid #A3B9C0;
}

.nav-link:hover {
border-style: none;
}

/* Collapsing of the TOC sidebar while scrolling */

/* Nav: hide second level (shown on .active) */
.bd-toc .nav .nav {
display: none;
}

.bd-toc .nav > .active > ul {
display: block;
}

/* Main index page overview cards */

.sd-card-img-top {
width: 33% !important;
display: block;
margin-left: auto;
margin-right: auto;
margin-top: 10px;
}

/* Hide ToC on mobile */
@media (max-width: 1200px) {
.bd-sidebar-secondary {
display: none;
}

.bd-sidebar-secondary.active .bd-toc.active {
display: block;
}


.article-header-buttons .sidebar-toggle {
display: block;
}

label.sidebar-toggle.primary-toggle {
display: none;
}
label.sidebar-toggle.secondary-toggle {
display: inline-block; /* or 'block', depending on desired layout */
}

}
6 changes: 6 additions & 0 deletions docs/_templates/autosummary/accessor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{ fullname }}
{{ underline }}

.. currentmodule:: {{ module.split('.')[0] }}

.. autoaccessor:: {{ (module.split('.')[1:] + [objname]) | join('.') }}
6 changes: 6 additions & 0 deletions docs/_templates/autosummary/accessor_attribute.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{ fullname }}
{{ underline }}

.. currentmodule:: {{ module.split('.')[0] }}

.. autoaccessorattribute:: {{ (module.split('.')[1:] + [objname]) | join('.') }}
6 changes: 6 additions & 0 deletions docs/_templates/autosummary/accessor_callable.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{ fullname }}
{{ underline }}

.. currentmodule:: {{ module.split('.')[0] }}

.. autoaccessorcallable:: {{ (module.split('.')[1:] + [objname]) | join('.') }}.__call__
6 changes: 6 additions & 0 deletions docs/_templates/autosummary/accessor_method.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{ fullname }}
{{ underline }}

.. currentmodule:: {{ module.split('.')[0] }}

.. autoaccessormethod:: {{ (module.split('.')[1:] + [objname]) | join('.') }}
Loading

0 comments on commit e560451

Please sign in to comment.