Merge pull request #124 from Project-MONAI/populate_docs

Populate initial user guide docs

Author: gigony

docs/_static/custom.css

@@ -7,27 +7,101 @@ https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/customizing.html
 body {
     font-family: "Roboto", sans-serif;
 }
+
 .wy-menu-vertical p.caption {
     color: #7cccc7;
 }
+
 * {
     font-variant-ligatures: none;
 }
+
 .autoclasstoc td {
     padding: 0.2rem;
     line-height: normal;
 }
-dl.field-list > dt {
+
+dl.field-list>dt {
     word-break: normal;
 }
 
-
-
 h5.card-header {
     margin-top: 0px;
     margin-bottom: 0px;
 }
+
 h5.card-header::before {
     height: 0px;
     margin-top: 0px;
 }
+
+
+/* Customize styles */
+
+:root {
+    --pst-color-inline-code: 232, 62, 140;
+    --pst-font-size-h1: 32px;
+    --pst-font-size-h2: 26px;
+    --pst-font-size-h3: 21px;
+    --pst-font-size-h4: 18px;
+    --pst-font-size-h5: 16px;
+    --pst-font-size-h6: 14px;
+}
+
+
+/* Customize headings */
+
+.heading-style,
+h1 {
+    font-family: Content-font, Roboto, sans-serif;
+    font-weight: 500;
+    line-height: 1.5;
+}
+
+/* Code Highlight */
+div[class^="highlight"] pre {
+    color: rgb(248, 248, 242);
+    background-color: rgb(41, 44, 46);
+    border: 0px;
+    box-shadow: none;
+}
+div.highlight{
+    border-radius: 5px;
+}
+div.highlight pre {
+    border-radius: 5px;
+}
+div.cell div.cell_input div.highlight {
+    border-radius: 0px;
+}
+
+/* Code Block Caption */
+div.code-block-caption {
+    font-weight: bold;
+    font-style: italic;
+}
+
+/* Code Line Highlight */
+.highlight .hll {
+    background-color: rgb(133, 132, 24);
+}
+
+/* Left bar color for cells in Jupyter Notebook */
+div.cell div.cell_input {
+    border-left-color: rgb(127, 218, 255)
+}
+
+/* Code highlight in source code view */
+.viewcode-block:target {
+    background-color: #382927;
+}
+
+/* Backquote */
+blockquote {
+    background-color: rgb(129 252 255 / 30%);
+    border-left: 8px solid rgb(127, 218, 255);
+    padding: 15px 30px 15px 15px;
+}
+blockquote p {
+    margin-bottom: 0px;
+}

docs/requirements.txt

@@ -30,3 +30,4 @@ sphinxcontrib-htmlhelp
 sphinxcontrib-jsmath
 sphinxcontrib-qthelp
 sphinxcontrib-serializinghtml
+sphinxcontrib-mermaid

docs/source/_templates/navbar-logo.html

@@ -10,8 +10,8 @@
     <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
   </a>
   <a href="{{ pathto(master_doc) }}">
-    <p style="z-index:100; position:absolute; font-size:16px; font-weight:bold; left:5px; top:45px; margin-bottom:0;">
-      Deploy Application SDK
+    <p style="z-index:100; position:absolute; font-size:16px; font-weight:bold; left:12px; top:45px; margin-bottom:0;">
+      Deploy App SDK
     </p>
   </a>
 </div>
@@ -22,6 +22,6 @@
 {% endif %}
 {% else %}
 <a class="navbar-brand" href="{{ pathto(master_doc) }}">
-<p class="title">{{ project }}</p>
+  <p class="title">{{ project }}</p>
 </a>
-{% endif %}
+{% endif %}

docs/source/_templates/sidebar-quicklinks.html

@@ -2,8 +2,8 @@
     <h5 class="card-header font-weight-bold">Version {{ release }}</h5>
     <div class="card-body">
         <ul class="list-group list-group-flush list-unstyled quicklinks">
-            <li><a href="{{ pathto('getting_started/tutorials/index.html', 1) }}"><i class="text-muted fas fa-book fa-fw"></i> Tutorials</a></li>
-            <li><a href="{{ pathto('release_notes/v' + version + '.html', 1) }}"><i class="text-muted fas fa-newspaper fa-fw"></i> Changelog</a></li>
+            <li><a href="{{ pathto('release_notes/v' + version + '.html', 1) }}"><i class="text-muted fas fa-newspaper fa-fw"></i> What's New</a></li>
+            <li><a href="{{ pathto('getting_started/tutorials/index.html', 1) }}"><i class="text-muted fas fa-book fa-fw"></i> Tutorials</a></li>            
             <li><a href="{{ pathto('https://github.com/Project-MONAI/monai-deploy-app-sdk/issues/new/choose', 1) }}"><i class="text-muted fas fa-question-circle fa-fw"></i> Get help</a></li>
             <li><a href="{{ pathto('introduction/contributing.html', 1) }}"><i class="text-muted fas fa-code-branch fa-fw"></i> Contribute</a></li>
         </ul>

docs/source/_templates/title.html

@@ -34,8 +34,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []  # type: ignore
-
+exclude_patterns = ["_build"]  # type: ignore
 
 # -- General configuration ---------------------------------------------------
 
@@ -67,12 +66,17 @@
     # https://myst-parser.readthedocs.io/en/latest/sphinx/use.html#automatically-create-targets-for-section-headers
     # "sphinx.ext.autosectionlabel",  <== don't need anymore from v0.13.0
     "sphinx_autodoc_typehints",
+    "sphinxcontrib.mermaid",
 ]
 
 autoclass_content = "both"
 add_module_names = True
 source_encoding = "utf-8"
-autosectionlabel_prefix_document = True
+# Prefix document path to section labels, to use:
+# `path/to/file:heading` instead of just `heading`
+# (https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html)
+# autosectionlabel_prefix_document = True
+# autosectionlabel_maxdepth = 4
 napoleon_use_param = True
 napoleon_include_init_with_doc = True
 set_type_checking_flag = True
@@ -140,7 +144,7 @@
     "index": ["search-field", "sidebar-quicklinks", "sidebar-nav-bs"],
     "**": ["search-field", "sidebar-nav-bs"],
 }
-pygments_style = "sphinx"
+pygments_style = "monokai"
 
 
 # -- Options for pydata-sphinx-theme -------------------------------------------------
@@ -182,14 +186,14 @@
     "dollarmath",
     "html_admonition",
     "html_image",
-    "linkify",
+    # "linkify",  # disable linkify to not confuse with the file name such as `app.py`
     "replacements",
     # "smartquotes",
     "substitution",
     "tasklist",
 ]
 # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#syntax-header-anchors
-myst_heading_anchors = 2
+myst_heading_anchors = 4
 
 
 # -- Options for myst-nb -------------------------------------------------

docs/source/conf.py

@@ -1 +1,3 @@
 # Core concepts
+
+This document introduces the basic concepts of the MONAI Deploy App SDK. If you are eager to try out the SDK in practice, you can start with the tutorial. After the tutorial, you can return to this document to learn more about how MONAI Deploy App SDK works.

docs/source/developing_with_sdk/connecting_operators.md

@@ -1 +1,3 @@
 # Creating Application class
+
+The Application class is perhaps the most important class that MONAI Deploy App developers will interact with.  A developer will inherit a new Application from the monai.core.Application base class. The base application class provides support for chaining up operators, as well as a mechanism to execute the application. The compose method of this class needs to be implemented in the inherited class to instantiate Operators and connect them together to form a Directed Acyclic Graph.