Skip to content

Commit

Permalink
small changes to apidocs md files (generated locally)
Browse files Browse the repository at this point in the history
  • Loading branch information
jkingslake committed Jan 15, 2025
1 parent 3a4e5c7 commit a8d0203
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/apidocs/xapres/xapres.load.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 26 additions & 0 deletions docs/apidocs/xapres/xapres.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,29 @@
xapres.utils
xapres.load
```

## Package Contents

### Data

````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`submodule_name <xapres.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
```
````

0 comments on commit a8d0203

Please sign in to comment.