Improve appearance of documentation (#280)

nums-project · Feb 21, 2022 · bf19956 · bf19956
1 parent 4b4bf89
commit bf19956
Show file tree

Hide file tree

Showing 26 changed files with 859 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/*/generated
 
 # PyBuilder
 target/

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -5,4 +5,6 @@ sphinx >=3, <4
 sphinx_rtd_theme
 sphinx-autodoc-typehints
 m2r2
-sphinx-autopackagesummary
+pydata-sphinx-theme
+sphinx-panels
+sphinx-autopackagesummary
diff --git a/docs/source/_static/css/nums.css b/docs/source/_static/css/nums.css
@@ -0,0 +1,44 @@
+/* Override some aspects of the pydata-sphinx-theme */
+
+:root {
+  /* Use softer blue from bootstrap's default info color */
+  --pst-color-info: 23, 162, 184;
+}
+
+/* Main index page overview cards */
+
+.intro-card {
+  background: #fff;
+  border-radius: 0;
+  padding: 30px 10px 20px 10px;
+  margin: 10px 0px;
+}
+
+.intro-card p.card-text {
+  margin: 0px;
+}
+
+.intro-card .card-img-top {
+  margin: 10px;
+  height: 52px;
+}
+
+.intro-card .card-header {
+  border: none;
+  background-color:white;
+  color: #150458 !important;
+  font-size: var(--pst-font-size-h5);
+  font-weight: bold;
+  padding: 2.5rem 0rem 0.5rem 0rem;
+}
+
+.intro-card .card-footer {
+  border: none;
+  background-color:white;
+}
+
+.intro-card .card-footer p.card-text{
+  max-width: 220px;
+  margin-left: auto;
+  margin-right: auto;
+}
diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico
diff --git a/docs/source/_static/index_api.svg b/docs/source/_static/index_api.svg
diff --git a/docs/source/_static/index_contribute.svg b/docs/source/_static/index_contribute.svg
diff --git a/docs/source/_static/index_getting_started.svg b/docs/source/_static/index_getting_started.svg
diff --git a/docs/source/_static/index_user_guide.svg b/docs/source/_static/index_user_guide.svg