Skip to content

Commit 42a5ddb

Browse files
committed
make documentation
1 parent 021cc62 commit 42a5ddb

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Developed by Jamila Taaki (MIDAS).
1717
Installation
1818
--------
1919

20-
.. code-block:: bash
20+
```
2121
pip install pystarshade
22-
22+
```
2323

2424
Usage
2525
--------
@@ -28,12 +28,13 @@ The simplest way to use PyStarshade is by calling the function 'source_field_to_
2828
takes as input a 2D source-field of size (N_s, N_s) and spatial sampling ds and returns the 2D output
2929
field incident on a CCD of size (N_pix, N_pix) and pixel size dp.
3030

31-
.. code-block:: python
31+
```
3232
from pystarshade.simulate_field import source_field_to_ccd
3333

3434
source_field_to_ccd(source_field, wl, dist_xo_ss, dist_ss_t, focal_length_lens, radius_lens,
3535
N_s = 333, N_x = 6401, N_t = 1001, N_pix = 4001,
3636
ds = 0.3*au_to_meter, dx = 0.01, dt = 0.0116, dp=.5*1.9e-7)```
37+
```
3738

3839
Input data
3940
--------

0 commit comments

Comments
 (0)