Update to v0.0.3, improve docs and fix css issues.

TravisWheelerLab · Mar 10, 2023 · 767e933 · 767e933
1 parent 55e7893
commit 767e933
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 12 deletions.
diff --git a/diplomat/__init__.py b/diplomat/__init__.py
@@ -2,7 +2,7 @@
 A tool providing multi-animal tracking capabilities on top of other Deep learning based tracking software.
 """
 
-__version__ = "0.0.2"
+__version__ = "0.0.3"
 # Can be used by functions to determine if diplomat was invoked through it's CLI interface.
 CLI_RUN = False
 

diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
@@ -69,20 +69,20 @@ p {
     /*--navbar-level-1-color: #c3e3ff;*/
     /*--navbar-level-2-color: #b8d6f0;*/
     /*--navbar-level-3-color: #a3c4e1;*/
-    --navbar-level-1-color: cadetblue;
-    --navbar-level-2-color: cadetblue;
-    --navbar-level-3-color: cadetblue;
+    --navbar-level-1-color: steelblue;
+    --navbar-level-2-color: steelblue;
+    --navbar-level-3-color: steelblue;
 
     --navbar-heading-color: #ff7381;
 
     /*--navbar-scrollbar-color: #d45a66;*/
     /*--navbar-scrollbar-hover-color: #b14550;*/
     /*--navbar-scrollbar-active-color: #72383e;*/
     /*--navbar-scrollbar-background: #131e2b;*/
-    --navbar-scrollbar-color: cadetblue;
-    --navbar-scrollbar-hover-color: #558e90;
-    --navbar-scrollbar-active-color: #426e70;
-    --navbar-scrollbar-background: #131e2b;
+    --navbar-scrollbar-color: steelblue;
+    --navbar-scrollbar-hover-color: #5f9fd4;
+    --navbar-scrollbar-active-color: #31609e;
+    --navbar-scrollbar-background: #cacaca;
 
     --link-color: #2980b9;
     --link-color-hover: #3091d1;
@@ -108,8 +108,7 @@ p {
     --search-credits-link-color: #4392c5; /* derived from --link-color */
 
 
-
---highlight-background-color: #efefef;
+    --highlight-background-color: #efefef;
     --highlight-background-emph-color: #dbe6c3;
     --highlight-default-color: #404040;
     --highlight-comment-color: #408090;
@@ -135,9 +134,9 @@ p {
     --admonition-danger-color: #404040;
     --admonition-danger-title-background-color: #e9a499;
     --admonition-danger-title-color: #fff;
-    --admonition-tip-background-color: #dbfaf4;
+    --admonition-tip-background-color: #dbf0fa;
     --admonition-tip-color: #404040;
-    --admonition-tip-title-background-color: #1abc9c;
+    --admonition-tip-title-background-color: #1a95bc;
     --admonition-tip-title-color: #fff;
 
     --kbd-background-color: #fafbfc;
@@ -153,6 +152,10 @@ p {
     --footer-color: #808080;
 }
 
+.icon-home {
+    color: var(--link-color) !important;
+}
+
 /*!* Dark theme colors *!*/
 /*@media (prefers-color-scheme: dark) {*/
 /*  :root {*/
@@ -594,6 +597,9 @@ footer,
 
 .wy-nav-content {
     background-color: var(--content-background-color);
+    z-index: 300;
+    box-shadow: 0 0 7px -3px black;
+    position: relative;
 }
 
 .wy-body-for-nav {
@@ -966,6 +972,7 @@ kbd.compound > .kbd,
 
 .wy-nav-side {
     background-color: var(--navbar-background-color);
+    box-shadow: 0 0 7px -3px black;
 }
 
 @media only screen and (min-width: 769px) {

diff --git a/docs/source/_templates/cli-entry-template.rst b/docs/source/_templates/cli-entry-template.rst
@@ -11,6 +11,8 @@
 
 {usage}
 
+{positional_arguments}
+
     .. rubric:: Options
 
     .. code-block:: text

diff --git a/docs/source/ext/plugin_docgen.py b/docs/source/ext/plugin_docgen.py
@@ -339,6 +339,17 @@ def write_cli_entry(cli_dir: Path, cmd_name: str, func) -> Tuple[str, str]:
 
     help_str = func_to_command(func, ArgumentParser(prog=cmd_name)).format_help()
     options = "\n".join(f"         {line}" for line in help_str.split("options:")[-1].split("\n"))
+
+    pos_split = help_str.split("positional arguments:")
+    if(len(pos_split) < 2):
+        positional_arguments = ""
+    else:
+        positional_arguments = (
+            "    .. rubric:: Positional Arguments\n\n"
+            "    .. code-block:: text\n\n"
+            + ("\n".join(f"        {line}" for line in pos_split[-1].split("options:")[0].split("\n")))
+        )
+
     summary = "\n".join(f"    {line}" for line in help_str.split("\n\n")[1].split("\n"))
     usage = "\n".join(f"        {line[7:] if(line.startswith('usage: ')) else line}" for line in help_str.split("\n\n")[0].split("\n"))
 
@@ -348,6 +359,7 @@ def write_cli_entry(cli_dir: Path, cmd_name: str, func) -> Tuple[str, str]:
             title_dash="-" * (len(cmd_name) + 4),
             summary=summary,
             options=options,
+            positional_arguments=positional_arguments,
             usage=usage
         ))
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,8 @@ @@
     {usage}
+    {positional_arguments}
         .. rubric:: Options
         .. code-block:: text
@@ Expand Down @@