Skip to content

Commit

Permalink
Merge pull request #7 from scipp/use-sciline
Browse files Browse the repository at this point in the history
Use sciline
  • Loading branch information
jl-wynen authored Dec 7, 2023
2 parents 523b49d + 87089d1 commit c54508a
Show file tree
Hide file tree
Showing 22 changed files with 1,017 additions and 719 deletions.
25 changes: 20 additions & 5 deletions docs/api-reference/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# API Reference

## Classes

## Module Attributes
```{eval-rst}
.. currentmodule:: ess.diffraction
.. autosummary::
:toctree: ../generated/classes
:template: class-template.rst
:recursive:
:toctree: ../generated/attributes
providers
```

## Top-level functions
Expand All @@ -17,6 +16,17 @@
.. autosummary::
:toctree: ../generated/functions
:recursive:
crop_tof
filter_events
finalize_histogram
group_by_two_theta
lowpass
merge_all_pixels
normalize_by_monitor
normalize_by_proton_charge
normalize_by_vanadium
remove_bad_pulses
```

## Submodules
Expand All @@ -26,4 +36,9 @@
:toctree: ../generated/modules
:template: module-template.rst
:recursive:
external.powgen
powder
types
uncertainty
```
15 changes: 15 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,21 @@

doctest_global_setup = '''
import numpy as np
try:
import scipp as sc
def do_not_plot(*args, **kwargs):
pass
sc.plot = do_not_plot
sc.Variable.plot = do_not_plot
sc.DataArray.plot = do_not_plot
sc.DataGroup.plot = do_not_plot
sc.Dataset.plot = do_not_plot
except ImportError:
# Scipp is not needed by docs if it is not installed.
pass
'''

# Using normalize whitespace because many __str__ functions in scipp produce
Expand Down
Loading

0 comments on commit c54508a

Please sign in to comment.