Docs for tui version release (#334)

* Starting tidying up the website and adding how-to for install and choosing terminal.

* Add first draft of walkthrough.

* Full thread through and text tidy up, add all internal and external links.

* Add textual-dev to dev dependencies.

* Delete test screenshot svgs.

* Testing resoltuion after 300 dpi in photoshop.

* Trying 600 dpi.

* Trying 1200 dpi!

* try with shareX

* Check how things render on macos few figures added.

* Adding screenshots for graphical interface part of walkthrough.

* Adding python API sections to walkthrough.

* First draft of the tutorial complete.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Continue drafting + dark mode datashuttle image.

* Adding pictures to HOW TO.

* Export dark mode datashuttle as artboard.

* Upload halfway through transfer page, need to check.

* Rough draft complete for all sections.

* something went wrong with git.

* finish first draft of all how-tos.

* Rename 'make_folders' to 'create_folders' in docs.

* First draft of docs complete.

* Add notes on taking screenshots.

* Minor formatting changes, improvements during doc writing.

* Remove high dpi screenshots that were slowing down git.

* Fix tests after DataShuttle changed to datashuttle.

* Fix top-level folder widget test.

* Fix errors introduced after API changes.

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: JoeZiminski

datashuttle/tui/app.py

@@ -43,7 +43,7 @@ class TuiApp(App):
 
     def compose(self) -> ComposeResult:
         yield Container(
-            Label("DataShuttle", id="mainwindow_banner_label"),
+            Label("datashuttle", id="mainwindow_banner_label"),
             Button(
                 "Select Existing Project",
                 id="mainwindow_existing_project_button",
@@ -118,7 +118,7 @@ def handle_open_filesystem_browser(self, path_: Path) -> None:
                 )
             else:
                 message = (
-                    "Unexpected error occurred. Please contact the DataShuttle"
+                    "Unexpected error occurred. Please contact the datashuttle"
                     "development team."
                 )
 

datashuttle/tui/configs.py

@@ -443,15 +443,15 @@ def setup_configs_for_a_new_project(self) -> None:
                 ).disabled = False
 
                 message = (
-                    "A DataShuttle project has now been created.\n\n "
+                    "A datashuttle project has now been created.\n\n "
                     "Next, setup the SSH connection. Once complete, navigate to the "
                     "'Main Menu' and proceed to the project page, where you will be "
                     "able to create and transfer project folders."
                 )
 
             else:
                 message = (
-                    "A DataShuttle project has now been created.\n\n "
+                    "A datashuttle project has now been created.\n\n "
                     "Next proceed to the project page, where you will be "
                     "able to create and transfer project folders."
                 )

datashuttle/tui/css/tui_menu.tcss

@@ -13,7 +13,7 @@
 #mainwindow_banner_label {
     border: hkey $primary;
     content-align: center middle;
-    text-style: italic bold;
+    text-style: bold;
     color: $text;
     width: 50%;
     height: 5;

datashuttle/utils/rclone.py

@@ -285,8 +285,8 @@ def assert_rclone_check_output_is_as_expected(result, symbol, convert_symbols):
     assert symbol in convert_symbols.keys(), "rclone check symbol is unknown."
     assert symbol != "!", (
         "Could not complete rlcone check. "
-        "This is unexpected. Please contact DataShuttle "
-        "devs at our GitHub page."
+        "This is unexpected. Please contact datashuttle "
+        "at our GitHub page."
     )
 
 

datashuttle/utils/ssh.py

@@ -129,13 +129,11 @@ def setup_ssh_key(
     """
     if not sys.stdin.isatty():
         utils.log_and_raise_error(
-            f"Attempting to run outside of a TTY terminal. "
-            f"This may happen if attempting to run in an IDE console. "
-            f"`getpass` (used for ssh password input) cannot run. "
-            f"Try running using the command-line-interface with "
-            f"'datashuttle {cfg.project_name} "
-            f"setup-ssh-connection-to-central-server' "
-            f"or in a terminal rather than IDE console.",
+            "Attempting to run outside of a TTY terminal. "
+            "This may happen if attempting to run in an IDE console. "
+            "`getpass` (used for ssh password input) cannot run. "
+            "Try using Python from the operating system "
+            "terminal to run this function.",
             RuntimeError,
         )
 

docs/rebuild.py

@@ -0,0 +1,10 @@
+import shutil
+import subprocess
+from pathlib import Path
+
+build_path = Path(__file__).parent / "build"
+
+if build_path.is_dir():
+    shutil.rmtree(build_path)
+
+subprocess.run("sphinx-build ./source ./build", shell=True)

docs/source/_static/NeuroBlueprint_project_tree_dark.png

@@ -46,3 +46,7 @@ html[data-theme=light] {
   height: auto;
   margin: 5px auto;
 }
+
+.center {
+    text-align: center;
+}