small edits, add copybutton extension

Libensemble · Aug 14, 2023 · 8117090 · 8117090
1 parent 875cc67
commit 8117090
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 10 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -92,6 +92,7 @@ def __getattr__(cls, name):
     "sphinx.ext.mathjax",
     "sphinxcontrib.autodoc_pydantic",
     "sphinx_design",
+    "sphinx_copybutton",
 ]
 bibtex_bibfiles = ["references.bib"]
 bibtex_default_style = "unsrt"

diff --git a/docs/dev_guide/dev_API/developer_API.rst b/docs/dev_guide/dev_API/developer_API.rst
@@ -1,5 +1,5 @@
-libEnsemble Internal Modules
-============================
+Internal Modules
+================
 
 This section documents the internal modules of libEnsemble.
 

diff --git a/docs/dev_guide/release_management/release_index.rst b/docs/dev_guide/release_management/release_index.rst
@@ -1,5 +1,5 @@
-Release Management for libEnsemble
-==================================
+Release Management
+==================
 
 This section documents the steps to be followed for each libEnsemble release.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,7 +6,7 @@
 .. include:: welcome.rst
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: User Guide:
 
    Quickstart<introduction>
@@ -17,7 +17,7 @@
    advanced_installation
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Tutorials:
 
    tutorials/local_sine_tutorial
@@ -27,7 +27,7 @@
    tutorials/calib_cancel_tutorial
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Examples:
 
    examples/gen_funcs
@@ -36,7 +36,7 @@
    examples/calling_scripts
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Additional References:
 
    FAQ
@@ -48,7 +48,7 @@
    posters
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Developer Guide:
 
    dev_guide/release_management/release_index

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -6,3 +6,4 @@ numpy
 sphinx_rtd_theme
 furo
 ipykernel
+sphinx-copybutton
diff --git a/docs/running_libE.rst b/docs/running_libE.rst
@@ -3,7 +3,7 @@
 Running libEnsemble
 ===================
 
-libEnsemble runs using a one-Manager/many-Worker paradigm. How these processes communicate
+libEnsemble runs with one and many workers. How these processes communicate
 is determined by the launch-method and ``comms`` option. The
 three options are ``mpi``, ``local``, ``tcp``. The default is ``mpi``.