Merge pull request #1162 from CEED/jed/doc-update-packages

doc: update packages

.readthedocs.yml

@@ -4,6 +4,17 @@
 # Required
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    nodejs: "19"
+  apt_packages:
+    - librsvg2-bin
+  jobs:
+    post_create_environment:
+      - npm install -g @mermaid-js/mermaid-cli
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   builder: dirhtml
@@ -15,6 +26,5 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.8
   install:
     - requirements: doc/sphinx/requirements.txt

doc/sphinx/requirements.txt

@@ -3,10 +3,10 @@ breathe>=4.30
 myst-parser[linkify]>=0.14.0
 sphinx-hoverxref>=0.3b1
 sphinx-design
-sphinx>=4.3
+sphinx>=5.3,<6
 sphinx_rtd_theme
-sphinxcontrib-bibtex==2.4.2
+sphinxcontrib-bibtex==2.5
 sphinxcontrib-katex
 sphinxcontrib-mermaid
 sphinxcontrib-svg2pdfconverter
-docutils==0.16
+docutils

doc/sphinx/source/conf.py

@@ -280,7 +280,6 @@
 
 
 # -- Options for breathe --------------------------------------------------
-sys.path.append(breathe.__path__)
 breathe_projects = {"libCEED": "../../../xml"}
 breathe_default_project = "libCEED"
 breathe_build_directory = "../build/breathe"

interface/ceed-operator.c

@@ -331,7 +331,8 @@ not have any field of a matching type.
   @param[in,out] op          CeedOperator
   @param[in]     field_label Label of field to set
   @param[in]     field_type  Type of field to set
-  @param[in]     value       Value to set
+  @param[out]    num_values  Number of values of type `field_type` in array `values`
+  @param[out]    values      Values in the label
 
   @return An error code: 0 - success, otherwise - failure
 
@@ -391,7 +392,7 @@ not have any field of a matching type.
   @param[in,out] op          CeedOperator
   @param[in]     field_label Label of field to set
   @param[in]     field_type  Type of field to set
-  @param[in]     value       Value to set
+  @param[in]     values      Values array to restore
 
   @return An error code: 0 - success, otherwise - failure
 
@@ -1586,7 +1587,7 @@ int CeedOperatorContextSetInt32(CeedOperator op, CeedContextFieldLabel field_lab
 
   @param[in]  op          CeedOperator
   @param[in]  field_label Label of field to get
-  @param[out] num_values  Number of values in the field label
+  @param[out] num_values  Number of int32 values in `values`
   @param[out] values      Pointer to context values
 
   @return An error code: 0 - success, otherwise - failure
@@ -1602,7 +1603,6 @@ int CeedOperatorContextGetInt32Read(CeedOperator op, CeedContextFieldLabel field
 
   @param[in]  op          CeedOperator
   @param[in]  field_label Label of field to get
-  @param[out] num_values  Number of values in the field label
   @param[out] values      Pointer to context values
 
   @return An error code: 0 - success, otherwise - failure

interface/ceed-preconditioning.c

@@ -1318,18 +1318,19 @@ int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssem
 
   @param[in]  data                  CeedOperatorAssemblyData
   @param[out] num_active_bases      Total number of active bases
-  @param[out] num_eval_mode_in      Pointer to hold array of numbers of input CeedEvalModes, or NULL.
+  @param[out] num_eval_modes_in     Pointer to hold array of numbers of input CeedEvalModes, or NULL.
                                       `eval_modes_in[0]` holds an array of eval modes for the first active basis.
-  @param[out] eval_mode_in          Pointer to hold arrays of input CeedEvalModes, or NULL.
+  @param[out] eval_modes_in         Pointer to hold arrays of input CeedEvalModes, or NULL.
   @param[out] eval_mode_offsets_in  Pointer to hold arrays of input offsets at each quadrature point.
-  @param[out] num_eval_mode_out     Pointer to hold array of numbers of output CeedEvalModes, or NULL
-  @param[out] eval_mode_out         Pointer to hold arrays of output CeedEvalModes, or NULL.
+  @param[out] num_eval_modes_out    Pointer to hold array of numbers of output CeedEvalModes, or NULL
+  @param[out] eval_modes_out        Pointer to hold arrays of output CeedEvalModes, or NULL.
   @param[out] eval_mode_offsets_out Pointer to hold arrays of output offsets at each quadrature point
   @param[out] num_output_components The number of columns in the assembled CeedQFunction matrix for each quadrature point,
                                       including contributions of all active bases
 
   @return An error code: 0 - success, otherwise - failure
 
+
   @ref Backend
 **/
 int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_active_bases, CeedInt **num_eval_modes_in,