From a8d020374bfac63409c329a26827f9e8c5effc5f Mon Sep 17 00:00:00 2001 From: jkingslake <48723181+jkingslake@users.noreply.github.com> Date: Wed, 15 Jan 2025 14:37:08 +0000 Subject: [PATCH] small changes to apidocs md files (generated locally) --- docs/apidocs/xapres/xapres.load.md | 2 +- docs/apidocs/xapres/xapres.md | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/apidocs/xapres/xapres.load.md b/docs/apidocs/xapres/xapres.load.md index bdd5253..5f92a2e 100644 --- a/docs/apidocs/xapres/xapres.load.md +++ b/docs/apidocs/xapres/xapres.load.md @@ -81,7 +81,7 @@ ```` -````{py:method} load_all(directory=None, file_numbers_to_process=None, file_names_to_process=None, bursts_to_process='All', remote_load=False, attended=False, polarmetric=False, corrected_pad=False, max_range=None, computeProfiles=True, addProfileToDs_kwargs={}) +````{py:method} load_all(directory=None, file_numbers_to_process=None, file_names_to_process=None, bursts_to_process='All', disable_progress_bar=True, attended=False, polarmetric=False, corrected_pad=False, max_range=None, computeProfiles=True, addProfileToDs_kwargs={}) :canonical: xapres.load.from_dats.load_all ```{autodoc2-docstring} xapres.load.from_dats.load_all diff --git a/docs/apidocs/xapres/xapres.md b/docs/apidocs/xapres/xapres.md index 4a9554c..6b92eb4 100644 --- a/docs/apidocs/xapres/xapres.md +++ b/docs/apidocs/xapres/xapres.md @@ -16,3 +16,29 @@ xapres.utils xapres.load ``` + +## Package Contents + +### Data + +````{list-table} +:class: autosummary longtable +:align: left + +* - {py:obj}`submodule_name ` + - ```{autodoc2-docstring} xapres.submodule_name + :summary: + ``` +```` + +### API + +````{py:data} submodule_name +:canonical: xapres.submodule_name +:value: > + 'bas-apres' + +```{autodoc2-docstring} xapres.submodule_name +``` + +````