[Doc] Change theme + fix and improve serving docs (#641)

mlrun · Jan 11, 2021 · 28a6201 · 28a6201
1 parent e80ccd3
commit 28a6201
Show file tree

Hide file tree

Showing 28 changed files with 1,452 additions and 218 deletions.
diff --git a/docs/MLRun_Character.png b/docs/MLRun_Character.png
diff --git a/docs/_static/images/graph-flow.svg b/docs/_static/images/graph-flow.svg
diff --git a/docs/api/mlrun.model.rst b/docs/api/mlrun.model.rst
@@ -4,4 +4,5 @@ mlrun.model
 .. automodule:: mlrun.model
    :members:
    :show-inheritance:
-   :undoc-members:
+   :no-undoc-members:
+   :exclude-members: ImageBuilder
diff --git a/docs/api/mlrun.runtimes.rst b/docs/api/mlrun.runtimes.rst
@@ -0,0 +1,7 @@
+mlrun.runtimes
+==============
+
+.. automodule:: mlrun.runtimes
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/mlrun.serving.rst b/docs/api/mlrun.serving.rst
@@ -0,0 +1,7 @@
+mlrun.serving
+==============
+
+.. automodule:: mlrun.serving
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/mlrun.utils.rst b/docs/api/mlrun.utils.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,7 +34,7 @@ def current_version():
 # -- Project information -----------------------------------------------------
 
 project = "mlrun"
-copyright = "2020, Iguazio"
+copyright = "2021, Iguazio"
 author = "Iguazio"
 
 master_doc = "index"
@@ -53,12 +53,12 @@ def current_version():
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "numpydoc",
-    "recommonmark",
+    "sphinx.ext.napoleon",
     "sphinx.ext.autodoc",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_copybutton",
+    "myst_nb",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -77,8 +77,9 @@ def current_version():
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 source_suffix = {
-    ".md": "markdown",
     ".rst": "restructuredtext",
+    ".ipynb": "myst-nb",
+    ".myst": "myst-nb",
 }
 
 
@@ -91,15 +92,31 @@ def current_version():
 try:
     import sphinx_rtd_theme  # noqa
 
-    html_theme = "sphinx_rtd_theme"
+    html_theme = "sphinx_book_theme"
 except ImportError:
     pass
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+html_title = "Mlrun"
+
+html_theme_options = {
+    "repository_url": "https://github.com/mlrun/mlrun",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+    "path_to_docs": "docs",
+    "home_page_in_toc": True,
+    "repository_branch": "development",
+}
 
+html_title = "The MLOps Stack"
+html_logo = "./MLRun_Character.png"
+html_favicon = "./favicon.ico"
+extra_navbar = "<p>Your HTML</p>"
+jupyter_execute_notebooks = "off"
 
 # -- Extension configuration -------------------------------------------------
 

diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/docs/index.rst b/docs/index.rst
@@ -33,7 +33,7 @@ MLRun includes the following key features:
 - **Managed pipelines** &mdash; deploy, run, and monitor your machine-learning execution plan.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents:
 
    quick-start
@@ -45,8 +45,14 @@ MLRun includes the following key features:
    projects
    load-from-marketplace
    job-submission-and-tracking
-   model-management-and-serving
+   serving/index
    examples
    cli
    api/index
 
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/model-management-and-serving.md b/docs/model-management-and-serving.md
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,3 +3,5 @@ recommonmark~=0.6
 sphinx~=2.2
 sphinx_rtd_theme~=0.4
 sphinx-copybutton~=0.3
+myst-nb~=0.10
+sphinx-book-theme~=0.0.39