Update docs site + release

warner-benjamin · Nov 19, 2022 · 313ca67 · 313ca67
1 parent 423ed12
commit 313ca67
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,8 @@
 fastxtend
 ================
 
-<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
-
-## Documentation
-
-<https://fastxtend.benjaminwarner.dev>
+fastxtend (fastai extended) is a collection of tools, extensions, and
+addons for fastai
 
 ## Feature overview
 
@@ -74,9 +71,13 @@ fastxtend
 Check out the documentation for additional splitters, callbacks,
 schedulers, utilities, and more.
 
+## Documentation
+
+<https://fastxtend.benjaminwarner.dev>
+
 ## Install
 
-To install, run:
+fastxtend is avalible on pypi:
 
 ``` default
 pip install fastxtend
@@ -133,7 +134,7 @@ Learner(..., metrics=[Accuracy(log_metric=LogMetric.Train, metric_type=MetricTyp
 Log multiple losses as individual metrics on train and valid:
 
 ``` python
-mloss = MultiLoss(loss_funcs=[nn.MSELoss, nn.L1Loss], 
+mloss = MultiLoss(loss_funcs=[nn.MSELoss, nn.L1Loss],
                   weights=[1, 3.5], loss_names=['mse_loss', 'l1_loss'])
 
 Learner(..., loss_func=mloss, metrics=RMSE(), cbs=MultiLossCallback)

diff --git a/fastxtend/__init__.py b/fastxtend/__init__.py
@@ -1 +1 @@
-__version__ = "0.0.13"
+__version__ = "0.0.14"
diff --git a/nbs/custom.scss b/nbs/custom.scss
@@ -124,6 +124,16 @@ $border-radius: 3px;
 
 .headroom { border-bottom: 2px solid; border-color: $black; }
 
+.navbar-dark .navbar-toggler-icon {
+  background-image: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'><path stroke='rgb(24, 24, 24)' stroke-linecap='round' stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/></svg>") !important
+}
+
+@media (max-width: 992px) {
+  .navbar-expand-lg {
+    border-bottom: 0.5px solid; border-color: $purple;
+  }
+}
+
 .nav-footer {
   border-top: 1px solid $footer-border-color;
   padding-top: 0.35rem !important;
@@ -155,7 +165,7 @@ a {
   color: $body-color;
 }
 
-.content { 
+.content {
   a { box-shadow: inset 0 -0.15rem 0 $link-color-underline;
       text-decoration: none;
       transition: all .15s cubic-bezier(.33,.66,.66,1);
@@ -167,25 +177,25 @@ a {
 
 .anchorjs-link {
   color: $body-color !important;
-  box-shadow: None !important; 
+  box-shadow: None !important;
 
-  &:hover { color: $link-color !important; 
+  &:hover { color: $link-color !important;
             box-shadow: None !important; }
 }
 
 // Code
 code {
-  border-radius: $border-radius !important; 
-  padding: $spacer/8 $spacer/8 !important; 
+  border-radius: $border-radius !important;
+  padding: $spacer/8 $spacer/8 !important;
 }
 
 a code { color: $purple;
          box-shadow: inset 0 -0.15rem 0 $link-color-underline;
          text-decoration: none;
          transition: all .15s cubic-bezier(.33,.66,.66,1);
          z-index: 10;
-         border-bottom-left-radius: 0 !important; 
-         border-bottom-right-radius: 0 !important; 
+         border-bottom-left-radius: 0 !important;
+         border-bottom-right-radius: 0 !important;
 
   &:hover { box-shadow: inset 0 -2rem 0 $link-color-hover-code;
             color: $body-color }
@@ -265,7 +275,7 @@ a code { color: $purple;
   background: rgb(180, 180, 180);
 }
 
-.sidebar::-webkit-scrollbar-thumb:hover, .sourceCode::-webkit-scrollbar-thumb:hover, pre::-webkit-scrollbar-thumb:hover, 
+.sidebar::-webkit-scrollbar-thumb:hover, .sourceCode::-webkit-scrollbar-thumb:hover, pre::-webkit-scrollbar-thumb:hover,
 .sidebar::-webkit-scrollbar-thumb:active, .sourceCode::-webkit-scrollbar-thumb:active, pre::-webkit-scrollbar-thumb:active {
   background: rgb(130, 130, 130);
 }

diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -12,8 +12,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Documentation\n",
-    "<https://fastxtend.benjaminwarner.dev>"
+    "::: {.content-hidden when-format=\"html\"}\n",
+    "fastxtend (fastai extended) is a collection of tools, extensions, and addons for fastai\n",
+    ":::"
    ]
   },
   {
@@ -50,13 +51,23 @@
     "Check out the documentation for additional splitters, callbacks, schedulers, utilities, and more."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "::: {.content-hidden when-format=\"html\"}\n",
+    "## Documentation\n",
+    "<https://fastxtend.benjaminwarner.dev>\n",
+    ":::"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "## Install\n",
     "\n",
-    "To install, run:\n",
+    "fastxtend is avalible on pypi:\n",
     "```default\n",
     "pip install fastxtend\n",
     "```\n",

diff --git a/settings.ini b/settings.ini
@@ -8,7 +8,7 @@ author = Benjamin Warner
 author_email = [email protected]
 copyright = Benjamin Warner
 branch = main
-version = 0.0.13
+version = 0.0.14
 min_python = 3.7
 audience = Developers
 language = English