changed ordert to 'by-source', worked on overview page

lbl-camera · Feb 18, 2022 · f28977a · f28977a
1 parent 553f611
commit f28977a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/source/api/overview.md b/docs/source/api/overview.md
@@ -9,3 +9,7 @@ fvGP can use [HGDL](https://hgdl.readthedocs.io) optimization on supercomputers
 
 The [fvGP](fvGP.md) class is a multi-output GP framework
 which inherits most of its functionality from the [GP](GP.md) base class.
+
+In the near future, new training engines will be offered, even more specialized
+to big-data and many-hyperparameter problems, allowing for ever-more powerful
+GPs to be deployed by the users.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -77,3 +77,4 @@
 
 # Configure execution (and output generation) of myst-nb files
 jupyter_execute_notebooks = "auto"
+autodoc_member_order = 'bysource'
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -1,5 +1,6 @@
 ---
 banner: _static/landing.png
+banner_height: "40vh"
 ---
 
 ```{toctree}
@@ -22,14 +23,14 @@ caption: Examples
 examples/single-task.ipynb
 ```
 
-# fvGP - A Flexible multi-task GP engine
+# fvGP - A Flexible Multi-Task GP Engine
 
 ## fvGP
 Welcome to the documentation of the fvGP API.
 fvGP is a next-generation Gaussian (and Gaussian-related) process engine for flexible, domain-informed and 
 HPC-ready stochastic function approximation. It is the backbone of the [gpCAM](https://gpcam.readthedocs.io) API.
 The objective of fvGP is to take care of the mathematics behind GP training and predictions but allow the user to have
-maximum flexibility in defining the GP. 
+maximum flexibility in defining the GP.
 
 ## See Also