update layout documentation

nicolaipalm · Mar 3, 2024 · 58fa2a9 · 58fa2a9
1 parent 56d568b
commit 58fa2a9
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/paref)
 
 
-[documentation](https://paref.readthedocs.io/en/latest/)//[notebooks](https://github.com/nicolaipalm/paref/tree/main/docs/notebooks)//[demo](https://huggingface.co/spaces/NicoPalm/paref-showcase)//[paper](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4668407)
+[documentation](https://paref.readthedocs.io/en/latest/index.html)//[notebooks](https://github.com/nicolaipalm/paref/tree/main/docs/notebooks)//[demo](https://huggingface.co/spaces/NicoPalm/paref-showcase)//[paper](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4668407)
 
 # Paref - problem tailored MOO for expensive black-box functions
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -63,6 +63,9 @@
     'github_url': 'https://github.com/nicolaipalm/paref',
     'search_bar_text': 'Search for treasure...',
 }
+html_sidebars = {
+  '**': []
+}  # remove primary sidebar
 
 html_title = 'Paref'
 

diff --git a/docs/description/basics.md b/docs/description/basics.md
@@ -20,10 +20,10 @@ is desirable. With Paref you can do exactly that.
 ## Workflow
 
 The workflow of Paref is simple:
-1. [Implement a blackbox function]()
+1. Implement a blackbox function
 2. Explore the target space (by calling the blackbox function's ``perform_lhc(n)`` method)
-3. [Apply a MOO algorithm reflecting your preference]()
-4. [Analyze the output]()
+3. Apply a MOO algorithm reflecting your preference
+4. Analyze the output
 5. Repeat steps 2-4 until satisfied
 
 <details>

diff --git a/docs/description/moo-algorithms.md b/docs/description/moo-algorithms.md
@@ -1,9 +1,11 @@
+:html_theme.sidebar_secondary.remove:
+
 # Parefs' MOO algorithms
 
 Paref provides a series of ready to use *generic* (mainly minimization algorithms)
 and *problem tailored* (i.e. targeting certain properties) MOO algorithms implemented in the ``ParefMOO`` interface.
 
-In order to apply any MOO algorithm (except ``ExpressSearch``which only needs the maximum number of iterations)
+In order to apply any MOO algorithm (except ``ExpressSearch`` which only needs the maximum number of iterations)
 you need to initialize (or implement your own) ``StoppingCriteria``
 indicating when to stop the optimization process and call the MOO algorithm to it and
 the black-box function (bbf).

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,3 +1,5 @@
+:html_theme.sidebar_secondary.remove:
+
 ================================
 MOO for Expensive Blackbox-Functions
 ================================
@@ -8,7 +10,7 @@ MOO for Expensive Blackbox-Functions
    :hidden:
 
       basics <./description/basics.md>
-      FAQs <./description/faqs.md>
+      faq <./description/faqs.md>
       trouble-shooting <./description/trouble-shooting.md>
       algorithms <./description/moo-algorithms.md>
       demo <https://huggingface.co/spaces/NicoPalm/paref-showcase>