rebuilt navigation entirely, now has new folder structure and simpler…

… headings

doc/source/conf.py

@@ -21,7 +21,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "seldon-core"
-copyright = "2019, Seldon Technologies Ltd"
+copyright = "2021, Seldon Technologies Ltd"
 author = "Seldon Technologies Ltd"
 
 # The short X.Y version
@@ -120,7 +120,7 @@
 # source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = "index"
+master_doc = "contents"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -196,6 +196,7 @@
         "repo_type": "github",
         "version_dropdown": True,
         "version_dropdown_text": "Versions",
+        "master_doc": False,
         "nav_links": [
             {
                 "href": "",

doc/source/contents.rst

@@ -0,0 +1,12 @@
+============
+Contents
+============
+
+.. toctree::
+
+   Getting Started </nav/getting-started.rst>
+   Concepts </nav/concepts.rst>
+   Configuration </nav/configuration.rst>
+   Tutorials </nav/tutorials.rst>
+   Reference <nav/reference.rst>
+   Contributing </nav/contributing.rst>

doc/source/index.rst

@@ -5,35 +5,6 @@ Seldon Core
 .. These are hidden links, which are not linked anywhere but may still be
    exposed through an URL in readthedocs
 .. TODO Filter through these to remove or ignore old ones
-.. toctree::
-   :hidden:
-
-   R Wrapping Docker <R/r_wrapping_docker>
-   Seldon OpenVINO <charts/seldon-openvino>
-   Custom svc Name <graph/custom_svc_name>
-   gRPC Load Balancing Ambassador <graph/grpc_load_balancing_ambassador>
-   Model REST gRPC Settings <graph/model_rest_grpc_settings>
-   Model svcOrch Sep <graph/model_svcorch_sep>
-   APIs Reference <reference/apis/readme>
-   Integration NVIDIA Link <reference/integration_nvidia_link>
-   Integration Sagemaker Link <reference/integration_sagemaker_link>
-   Quickstart <workflow/quickstart>
-   S2I <wrappers/s2i>
-   Ambassador Circuit Breakers <examples/ambassador_circuit_breakers>
-   Istio <examples/istio>
-   Custom Metrics <examples/custom_metrics>
-   Drift CIFAR10 <examples/drift_cifar10>
-   Pachyderm <examples/pachyderm-simple>
-   DVC <examples/dvc>
-   Custom Init Container <examples/custom_init_container>
-   Graph Metadata <examples/graph-metadata>
-   Metadata <examples/metadata>
-   Metadata gRPC <examples/metadata_grpc>
-   Metadata Schema <examples/metadata_schema>
-   PVC TFJob <examples/pvc-tfjob>
-   Seldon Client <examples/seldon_client>
-   Server Examples <examples/server_examples>
-
 .. image:: ./images/core-logo-small.png
    :alt: Seldon logo
    :align: center
@@ -56,145 +27,3 @@ Quick Links
 * Learn how you can `start contributing <./developer/contributing.html>`_
 * Check out `Blogs <./tutorials/blogs.html>`_ that dive into Seldon Core components
 * Watch some of the `Videos and Talks <./tutorials/videos.html>`_ using Seldon Core
-
-.. image:: ./images/seldon-core-high-level.jpg
-   :alt: Seldon logo
-   :align: center
-
-Documentation Index
--------------------
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Getting Started
-
-   Quickstart Guide <workflow/github-readme.rst>
-   Overview of Components <workflow/overview.md>
-   Install on Kubernetes <workflow/install.md>
-   Join the Community <developer/community.md>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Seldon Core Deep Dive
-
-   Detailed Installation Parameters <reference/helm.rst>
-   Pre-packaged Inference Servers <servers/overview.md>
-   Language Wrappers for Custom Models <wrappers/language_wrappers.md>
-   Create your Inference Graph <graph/inference-graph.md>
-   Deploy your Model  <workflow/deploying.md>
-   Testing your Model Endpoints  <workflow/serving.md>
-   Python Module and Client <python/index.rst>
-   Troubleshooting guide <workflow/troubleshooting.md>
-   Usage reporting <workflow/usage-reporting.md>
-   Upgrading <reference/upgrading.md>
-   Changelog <reference/changelog.rst>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Pre-Packaged Inference Servers
-
-   Configuration <servers/index>
-   MLflow Server <servers/mlflow.md>
-   SKLearn Server <servers/sklearn.md>
-   Triton Inference Server <servers/triton.md>
-   Tempo Server <servers/tempo.md>   
-   Tensorflow Serving <servers/tensorflow.md>
-   XGBoost Server <servers/xgboost.md>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Production
-
-   AB Tests and Progressive Rollouts <rollouts/abtests.md>
-   Supported API Protocols <graph/protocols.md>
-   CI/CD MLOps at Scale <analytics/cicd-mlops.md>
-   Metrics with Prometheus <analytics/analytics.md>
-   Model Metadata <reference/apis/metadata.md>
-   Prediction Request Logging <analytics/logging.md>
-   Distributed Tracing with Jaeger <graph/distributed-tracing.md>
-   Replica Scaling  <graph/scaling.md>
-   Budgeting Disruptions <graph/disruption-budgets.md>
-   Custom Inference Servers <servers/custom.md>
-   Inference Optimization <production/optimization.md>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Language Wrappers
-
-   Python Language Wrapper <python/index.rst>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Incubating Projects
-
-   Java Language Wrapper <java/README.md>
-   Java (JNI) Language Wrapper [ALPHA] <java-jni/README.md>
-   C++ Language Wrapper [ALPHA] <cpp/README.md>
-   R Language Wrapper [ALPHA] <R/README.md>
-   NodeJS Language Wrapper [ALPHA] <nodejs/README.md>
-   Go Language Wrapper [ALPHA] <go/go_wrapper_link.rst>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Ingress
-
-   Ambassador Ingress <ingress/ambassador.md>
-   Istio Ingress <ingress/istio.md>
-   OpenShift <ingress/openshift.md>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Streaming and Batch Processing
-
-   Overview of Batch Processing <servers/batch.md>
-   Stream Processing with KNative <streaming/knative_eventing.md>
-   Native Kafka Integration <streaming/kafka.md>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Advanced Inference
-
-   Model Explanations <analytics/explainers.md>
-   Outlier Detection <analytics/outlier_detection.md>
-   Drift Detection <analytics/drift_detection.md>
-   Routers (incl. Multi Armed Bandits)  <analytics/routers.md>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Examples
-
-   Notebooks <examples/notebooks>
-   Articles/Blogs <tutorials/blogs>
-   Videos <tutorials/videos>
-   Podcasts <tutorials/podcasts>
-   Kubeflow Pipelines <https://github.com/kubeflow/pipelines/blob/master/samples/contrib/e2e-outlier-drift-explainer/seldon/README.md>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Reference
-
-   Annotation-based Configuration <graph/annotations.md>
-   AWS Marketplace Install <reference/aws-mp-install.md>
-   Benchmarking <reference/benchmarking.md>
-   General Availability <reference/ga.md>
-   Helm Charts <graph/helm_charts.md>
-   Images <reference/images.md>
-   Logging & Log Level <analytics/log_level.md>
-   Private Docker Registry <graph/private_registries.md>
-   Prediction APIs <reference/apis/index>
-   Python API reference <python/api/modules>
-   Release Highlights <reference/release-highlights>
-   Seldon Deployment CRD <reference/seldon-deployment.md>
-   Service Orchestrator <graph/svcorch.md>
-   Kubeflow <analytics/kubeflow.md>
-   Concepts <reference/concepts.md>
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Developer
-
-   Overview <developer/readme.md>
-   Contributing to Seldon Core <developer/contributing.rst>
-   End to End Tests <developer/e2e.rst>
-   Roadmap <developer/roadmap.md>
-   Build using private repo <developer/build-using-private-repo.md>

doc/source/nav/concepts.rst

@@ -0,0 +1,3 @@
+==============
+Concepts
+==============

doc/source/nav/config/deployments.rst

@@ -0,0 +1,15 @@
+============================
+Deployments
+============================
+
+.. toctree::
+   :maxdepth: 1
+
+   Deployment Techniques </workflow/deploying.md>
+   Supported API Protocols </graph/protocols.md>
+   Testing Model Endpoints </workflow/serving.md>
+   Replica Scaling </graph/scaling.md>
+   Model Metadata </reference/apis/metadata.md>
+   Budgeting Disruptions </graph/disruption-budgets.md>
+   AB Tests and Progressive Rollouts </rollouts/abtests.md>
+   Troubleshooting Deployments </workflow/troubleshooting.md>

doc/source/nav/config/installation.rst

@@ -0,0 +1,11 @@
+============================
+Installation Configuration
+============================
+
+.. toctree::
+    :maxdepth: 1
+
+    Detailed Installation Parameters </reference/helm.rst>
+    Usage Reporting </workflow/usage-reporting.md>
+    Changelog </reference/changelog.rst>
+    Upgrading </reference/upgrading.md>

doc/source/nav/config/integrations.rst

@@ -0,0 +1,18 @@
+============================
+Integrations
+============================
+
+.. toctree::
+    :maxdepth: 1
+
+    CI/CD MLOps at Scale </analytics/cicd-mlops.md>
+    Payload Logging </analytics/logging.md>
+    Distributed Tracing with Jaeger </graph/distributed-tracing.md>
+    Batch Processing </servers/batch.md>
+    Stream Processing with KNative </streaming/knative_eventing.md>
+    Metrics with Prometheus </analytics/analytics.md>
+    Native Kafka Integration </streaming/kafka.md>
+    Drift Detection </analytics/drift_detection.md>
+    Model Explanations </analytics/explainers.md>
+    Outlier Detection </analytics/outlier_detection.md>
+

doc/source/nav/config/routing.rst

@@ -0,0 +1,13 @@
+============================
+Routing
+============================
+
+.. toctree::
+    :maxdepth: 1
+
+    Istio Ingress </ingress/istio.md>
+    Ambassador Ingress </ingress/ambassador.md>
+    OpenShift </ingress/openshift.md>
+    Routers (incl. Multi armed Bandits) </analytics/routers.md>
+    Inference Graphs </graph/inference-graph.md>
+

doc/source/nav/config/servers.rst

@@ -0,0 +1,17 @@
+============================
+Servers
+============================
+
+.. toctree::
+    :maxdepth: 1
+
+    Custom Inference Servers </servers/custom.md>
+    Storage Initializers </servers/index.rst>
+    Inference Optimization </production/optimization.md>
+    XGBoost Server </servers/xgboost.md>
+    Triton Inference Server </servers/triton.md>
+    SKLearn Server </servers/sklearn.md>
+    Tempo Server </servers/tempo.md>
+    MLFlow Server </servers/mlflow.md>
+    TensorFlow Serving </servers/tensorflow.md>
+

doc/source/nav/config/wrappers.rst

@@ -0,0 +1,13 @@
+============================
+Wrappers and SDKs
+============================
+
+.. toctree::
+    :maxdepth: 1
+
+    Python Language Wrapper </python/index.rst>
+    Go Language Wrapper </go/go_wrapper_link.rst>
+    Java Language Wrapper </java/README.md>
+    Nodejs Language Wrapper </nodejs/README.md>
+    C++ Language Wrapper </cpp/README.md>
+    R Language Wrapper </R/README.md>

doc/source/nav/configuration.rst

@@ -0,0 +1,13 @@
+================
+Configuration
+================
+
+.. toctree::
+    :maxdepth: 1
+
+    Installation </nav/config/installation.rst>
+    Deployments </nav/config/deployments.rst>
+    Servers </nav/config/servers.rst>
+    Routing </nav/config/routing.rst>
+    Wrappers and SDKs </nav/config/wrappers.rst>
+    Integrations </nav/config/integrations.rst>

doc/source/nav/contributing.rst

@@ -0,0 +1,12 @@
+============================
+Contributing
+============================
+
+.. toctree::
+    :maxdepth: 1
+
+    Overview </developer/readme.md>
+    Contributing to Seldon Core </developer/contributing.rst>
+    End to End Tests </developer/e2e.rst>
+    Roadmap </developer/roadmap.md>
+    Build using private repo </developer/build-using-private-repo.md>

doc/source/nav/getting-started.rst

@@ -0,0 +1,9 @@
+==============
+Quickstart
+==============
+
+.. toctree::
+    :maxdepth: 1
+
+    Quickstart Guide </workflow/github-readme.rst>
+    Installation </nav/installation.rst>

doc/source/nav/installation.rst

@@ -0,0 +1,9 @@
+==============
+Installation
+==============
+
+.. toctree::
+    :maxdepth: 1
+    :titlesonly:
+
+    Installation on Kubernetes </workflow/install.md>

doc/source/nav/reference.rst

@@ -0,0 +1,20 @@
+============================
+Reference
+============================
+
+.. toctree::
+    :maxdepth: 1
+
+    Annotation Based Configuration </graph/annotations.md>
+    Benchmarking </reference/benchmarking.md>
+    General Availability </reference/ga.md>
+    Helm Charts </graph/helm_charts.md>
+    Images </reference/images.md>
+    Logging and Log Level </analytics/log_level.md>
+    Private Docker Registry </graph/private_registries.md>
+    Prediction APIs </reference/apis/index>
+    Python API Reference </python/api/modules.rst>
+    Release Highlights </reference/release-highlights>
+    Seldon Deployment CRD </reference/seldon-deployment.md>
+    Service Orchestrator </graph/svcorch.md>
+    Kubeflow </analytics/kubeflow.md>