Change the style in mkdocs.yml

Author: voetberg

tools/run_in_docker/generate_client_api_docs.sh

@@ -6,6 +6,7 @@ echo "Generating the Client Api Docs..."
 
 yq e -i '.docs_dir = "/auto_generated/client_api"' mkdocs.yml
 yq e -i '.site_name = "Rucio Python Client Documentation"' mkdocs.yml
+yq -i '.plugins[2].mkdocstrings.handlers.python.options.docstring_style = "numpy"' mkdocs.yml
 
 pip install --upgrade mkdocs mkdocs-gen-files mkdocstrings-python mkdocs-material
 mkdir -p /auto_generated/client_api

tools/run_in_docker/generate_docs.sh

@@ -18,7 +18,7 @@ fi
 
 cp rucio/etc/docker/test/extra/rucio_sqlite.cfg /opt/rucio/etc/rucio.cfg
 
-"$SCRIPT_DIR"/generate_rest_api_docs.sh
-"$SCRIPT_DIR"/generate_bin_help_docs.sh
+# "$SCRIPT_DIR"/generate_rest_api_docs.sh
+# "$SCRIPT_DIR"/generate_bin_help_docs.sh
 "$SCRIPT_DIR"/generate_client_api_docs.sh
 "$SCRIPT_DIR"/generate_policy_docs.sh

tools/run_in_docker/generate_policy_docs.sh

@@ -10,6 +10,7 @@ function mkdocs_build {
     echo "Generating $2..."
     yq e -i '.docs_dir = "/auto_generated/'$1'"' mkdocs.yml
     yq e -i ".site_name = \"Rucio $2 Documentation\"" mkdocs.yml
+    yq -i '.plugins[2].mkdocstrings.handlers.python.options.docstring_style = "sphinx"' mkdocs.yml
 
     mkdocs build --clean --no-directory-urls --site-dir $1
     cp -r $1 /auto_generated/

tools/run_in_docker/mkdocs.yml

@@ -44,6 +44,6 @@ plugins:
             show_source: false
             allow_inspection: false
             merge_init_into_class: true
-            docstring_style: "sphinx"
+            docstring_style: "numpy"
             show_category_heading: true
             show_bases: false