Skip to content

Commit 436480a

Browse files
committed
Add links to generated API docs
1 parent 6b32fcb commit 436480a

111 files changed

Lines changed: 553 additions & 407 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/iau.ab.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ IAU.ab(pnat, v, s, bm1)
66

77
Apply aberration to transform natural direction into proper
88
direction.
9-
SOFA (Standards of Fundamental Astronomy) software collection.
10-
119

1210
## Given:
1311
pnat double[3] natural direction to the source (unit vector)
@@ -34,7 +32,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
3432
0.4 microarcsecond.
3533

3634
2) In almost all cases, the maximum accuracy will be limited by the
37-
supplied velocity. For example, if the SOFA iauEpv00 function is
35+
supplied velocity. For example, if the SOFA [iauEpv00][1] function is
3836
used, errors of up to 5 microarcseconds could occur.
3937

4038
## References:
@@ -55,4 +53,6 @@ This revision: 2013 October 9
5553

5654
SOFA release 2018-01-30
5755

58-
Copyright (C) 2018 IAU SOFA Board.
56+
Copyright (C) 2018 IAU SOFA Board.
57+
58+
[1]: iau.epv00.md

docs/iau.af2a.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
```
66

77
Convert degrees, arcminutes, arcseconds to radians.
8-
SOFA (Standards of Fundamental Astronomy) software collection.
9-
108

119
## Given:
1210
```

docs/iau.apcg.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ The Earth ephemeris is supplied by the caller.
1111
The parameters produced by this function are required in the
1212
parallax, light deflection and aberration parts of the astrometric
1313
transformation chain.
14-
SOFA (Standards of Fundamental Astronomy) software collection.
15-
1614

1715
## Given:
1816
```
@@ -24,7 +22,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
2422

2523
## Returned:
2624
```
27-
astrom iauASTROM* star-independent astrometry parameters:
25+
astrom ASTROM* star-independent astrometry parameters:
2826
pmt double PM time interval (SSB, Julian years)
2927
eb double[3] SSB to observer (vector, au)
3028
eh double[3] Sun to observer (unit vector)
@@ -103,7 +101,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
103101
transformation), and atmospheric refraction.
104102

105103
4) The context structure astrom produced by this function is used by
106-
iauAtciq* and iauAticq*.
104+
[iauAtciq][13]* and [iauAticq][14]*.
107105

108106
## Called:
109107
```
@@ -114,4 +112,7 @@ This revision: 2013 October 9
114112

115113
SOFA release 2018-01-30
116114

117-
Copyright (C) 2018 IAU SOFA Board.
115+
Copyright (C) 2018 IAU SOFA Board.
116+
117+
[13]: iau.atciq.md
118+
[14]: iau.aticq.md

docs/iau.apcg13.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ the Earth ephemeris.
1212
The parameters produced by this function are required in the
1313
parallax, light deflection and aberration parts of the astrometric
1414
transformation chain.
15-
SOFA (Standards of Fundamental Astronomy) software collection.
16-
1715

1816
## Given:
1917
```
@@ -23,7 +21,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
2321

2422
## Returned:
2523
```
26-
astrom iauASTROM* star-independent astrometry parameters:
24+
astrom ASTROM* star-independent astrometry parameters:
2725
pmt double PM time interval (SSB, Julian years)
2826
eb double[3] SSB to observer (vector, au)
2927
eh double[3] Sun to observer (unit vector)
@@ -73,7 +71,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
7371
2) All the vectors are with respect to BCRS axes.
7472

7573
3) In cases where the caller wishes to supply his own Earth
76-
ephemeris, the function iauApcg can be used instead of the present
74+
ephemeris, the function [iauApcg][1] can be used instead of the present
7775
function.
7876

7977
4) This is one of several functions that inserts into the astrom
@@ -106,7 +104,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
106104
transformation), and atmospheric refraction.
107105

108106
5) The context structure astrom produced by this function is used by
109-
iauAtciq* and iauAticq*.
107+
[iauAtciq][13]* and [iauAticq][14]*.
110108

111109
## Called:
112110
```
@@ -118,4 +116,8 @@ This revision: 2013 October 9
118116

119117
SOFA release 2018-01-30
120118

121-
Copyright (C) 2018 IAU SOFA Board.
119+
Copyright (C) 2018 IAU SOFA Board.
120+
121+
[1]: iau.apcg.md
122+
[13]: iau.atciq.md
123+
[14]: iau.aticq.md

docs/iau.apci.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ caller.
1212
The parameters produced by this function are required in the
1313
parallax, light deflection, aberration, and bias-precession-nutation
1414
parts of the astrometric transformation chain.
15-
SOFA (Standards of Fundamental Astronomy) software collection.
16-
1715

1816
## Given:
1917
```
@@ -27,7 +25,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
2725

2826
## Returned:
2927
```
30-
astrom iauASTROM* star-independent astrometry parameters:
28+
astrom ASTROM* star-independent astrometry parameters:
3129
pmt double PM time interval (SSB, Julian years)
3230
eb double[3] SSB to observer (vector, au)
3331
eh double[3] Sun to observer (unit vector)
@@ -77,7 +75,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
7775
2) All the vectors are with respect to BCRS axes.
7876

7977
3) In cases where the caller does not wish to provide the Earth
80-
ephemeris and CIP/CIO, the function iauApci13 can be used instead
78+
ephemeris and CIP/CIO, the function [iauApci13][1] can be used instead
8179
of the present function. This computes the required quantities
8280
using other SOFA functions.
8381

@@ -111,7 +109,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
111109
transformation), and atmospheric refraction.
112110

113111
5) The context structure astrom produced by this function is used by
114-
iauAtciq* and iauAticq*.
112+
[iauAtciq][13]* and [iauAticq][14]*.
115113

116114
## Called:
117115
```
@@ -123,4 +121,8 @@ This revision: 2013 September 25
123121

124122
SOFA release 2018-01-30
125123

126-
Copyright (C) 2018 IAU SOFA Board.
124+
Copyright (C) 2018 IAU SOFA Board.
125+
126+
[1]: iau.apci13.md
127+
[13]: iau.atciq.md
128+
[14]: iau.aticq.md

docs/iau.apci13.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ to predict the Earth ephemeris and CIP/CIO.
1212
The parameters produced by this function are required in the
1313
parallax, light deflection, aberration, and bias-precession-nutation
1414
parts of the astrometric transformation chain.
15-
SOFA (Standards of Fundamental Astronomy) software collection.
16-
1715

1816
## Given:
1917
```
@@ -23,7 +21,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
2321

2422
## Returned:
2523
```
26-
astrom iauASTROM* star-independent astrometry parameters:
24+
astrom ASTROM* star-independent astrometry parameters:
2725
pmt double PM time interval (SSB, Julian years)
2826
eb double[3] SSB to observer (vector, au)
2927
eh double[3] Sun to observer (unit vector)
@@ -74,7 +72,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
7472
2) All the vectors are with respect to BCRS axes.
7573

7674
3) In cases where the caller wishes to supply his own Earth
77-
ephemeris and CIP/CIO, the function iauApci can be used instead
75+
ephemeris and CIP/CIO, the function [iauApci][1] can be used instead
7876
of the present function.
7977

8078
4) This is one of several functions that inserts into the astrom
@@ -107,7 +105,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
107105
transformation), and atmospheric refraction.
108106

109107
5) The context structure astrom produced by this function is used by
110-
iauAtciq* and iauAticq*.
108+
[iauAtciq][13]* and [iauAticq][14]*.
111109

112110
## Called:
113111
```
@@ -123,4 +121,8 @@ This revision: 2013 October 9
123121

124122
SOFA release 2018-01-30
125123

126-
Copyright (C) 2018 IAU SOFA Board.
124+
Copyright (C) 2018 IAU SOFA Board.
125+
126+
[1]: iau.apci.md
127+
[13]: iau.atciq.md
128+
[14]: iau.aticq.md

docs/iau.apco.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ parameters for transformations between ICRS and observed
99
coordinates. The caller supplies the Earth ephemeris, the Earth
1010
rotation information and the refraction constants as well as the
1111
site coordinates.
12-
SOFA (Standards of Fundamental Astronomy) software collection.
13-
1412

1513
## Given:
1614
```
@@ -32,7 +30,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
3230

3331
## Returned:
3432
```
35-
astrom iauASTROM* star-independent astrometry parameters:
33+
astrom ASTROM* star-independent astrometry parameters:
3634
pmt double PM time interval (SSB, Julian years)
3735
eb double[3] SSB to observer (vector, au)
3836
eh double[3] Sun to observer (unit vector)
@@ -110,7 +108,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
110108

111109
7) In cases where the caller does not wish to provide the Earth
112110
Ephemeris, the Earth rotation information and refraction
113-
constants, the function iauApco13 can be used instead of the
111+
constants, the function [iauApco13][1] can be used instead of the
114112
present function. This starts from UTC and weather readings etc.
115113
and computes suitable values using other SOFA functions.
116114

@@ -144,7 +142,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
144142
transformation), and atmospheric refraction.
145143

146144
9) The context structure astrom produced by this function is used by
147-
iauAtioq, iauAtoiq, iauAtciq* and iauAticq*.
145+
[iauAtioq][13], [iauAtoiq][14], [iauAtciq][15]* and [iauAticq][16]*.
148146

149147
## Called:
150148
```
@@ -160,4 +158,10 @@ This revision: 2013 October 9
160158

161159
SOFA release 2018-01-30
162160

163-
Copyright (C) 2018 IAU SOFA Board.
161+
Copyright (C) 2018 IAU SOFA Board.
162+
163+
[1]: iau.apco13.md
164+
[13]: iau.atioq.md
165+
[14]: iau.atoiq.md
166+
[15]: iau.atciq.md
167+
[16]: iau.aticq.md

docs/iau.apco13.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ obtain the Earth ephemeris, CIP/CIO and refraction constants.
1313
The parameters produced by this function are required in the
1414
parallax, light deflection, aberration, and bias-precession-nutation
1515
parts of the ICRS/CIRS transformations.
16-
SOFA (Standards of Fundamental Astronomy) software collection.
17-
1816

1917
## Given:
2018
```
@@ -33,7 +31,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
3331

3432
## Returned:
3533
```
36-
astrom iauASTROM* star-independent astrometry parameters:
34+
astrom ASTROM* star-independent astrometry parameters:
3735
pmt double PM time interval (SSB, Julian years)
3836
eb double[3] SSB to observer (vector, au)
3937
eh double[3] Sun to observer (unit vector)
@@ -71,14 +69,14 @@ SOFA (Standards of Fundamental Astronomy) software collection.
7169
present function is that the JD day represents UTC days whether
7270
the length is 86399, 86400 or 86401 SI seconds.
7371

74-
Applications should use the function iauDtf2d to convert from
72+
Applications should use the function [iauDtf2d][1] to convert from
7573
calendar date and time of day into 2-part quasi Julian Date, as
7674
it implements the leap-second-ambiguity convention just
7775
described.
7876

7977
2) The warning status "dubious year" flags UTCs that predate the
8078
introduction of the time scale or that are too far in the
81-
future to be trusted. See iauDat for further details.
79+
future to be trusted. See [iauDat][2] for further details.
8280

8381
3) UT1-UTC is tabulated in IERS bulletins. It increases by exactly
8482
one second at the end of each positive UTC leap second,
@@ -132,7 +130,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
132130

133131
9) In cases where the caller wishes to supply his own Earth
134132
ephemeris, Earth rotation information and refraction constants,
135-
the function iauApco can be used instead of the present function.
133+
the function [iauApco][3] can be used instead of the present function.
136134

137135
10) This is one of several functions that inserts into the astrom
138136
structure star-independent parameters needed for the chain of
@@ -164,7 +162,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
164162
```
165163

166164
11) The context structure astrom produced by this function is used
167-
by iauAtioq, iauAtoiq, iauAtciq* and iauAticq*.
165+
by [iauAtioq][15], [iauAtoiq][16], [iauAtciq][17]* and [iauAticq][18]*.
168166

169167
## Called:
170168
```
@@ -186,4 +184,12 @@ This revision: 2013 December 5
186184

187185
SOFA release 2018-01-30
188186

189-
Copyright (C) 2018 IAU SOFA Board.
187+
Copyright (C) 2018 IAU SOFA Board.
188+
189+
[1]: iau.dtf2d.md
190+
[2]: iau.dat.md
191+
[3]: iau.apco.md
192+
[15]: iau.atioq.md
193+
[16]: iau.atoiq.md
194+
[17]: iau.atciq.md
195+
[18]: iau.aticq.md

docs/iau.apcs.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ caller.
1212
The parameters produced by this function are required in the space
1313
motion, parallax, light deflection and aberration parts of the
1414
astrometric transformation chain.
15-
SOFA (Standards of Fundamental Astronomy) software collection.
16-
1715

1816
## Given:
1917
```
@@ -26,7 +24,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
2624

2725
## Returned:
2826
```
29-
astrom iauASTROM* star-independent astrometry parameters:
27+
astrom ASTROM* star-independent astrometry parameters:
3028
pmt double PM time interval (SSB, Julian years)
3129
eb double[3] SSB to observer (vector, au)
3230
eh double[3] Sun to observer (unit vector)
@@ -88,9 +86,9 @@ SOFA (Standards of Fundamental Astronomy) software collection.
8886
```
8987

9088
4) In cases where the caller does not wish to provide the Earth
91-
ephemeris, the function iauApcs13 can be used instead of the
89+
ephemeris, the function [iauApcs13][1] can be used instead of the
9290
present function. This computes the Earth ephemeris using the
93-
SOFA function iauEpv00.
91+
SOFA function [iauEpv00][2].
9492

9593
5) This is one of several functions that inserts into the astrom
9694
structure star-independent parameters needed for the chain of
@@ -122,7 +120,7 @@ SOFA (Standards of Fundamental Astronomy) software collection.
122120
transformation), and atmospheric refraction.
123121

124122
6) The context structure astrom produced by this function is used by
125-
iauAtciq* and iauAticq*.
123+
[iauAtciq][14]* and [iauAticq][15]*.
126124

127125
## Called:
128126
```
@@ -136,4 +134,9 @@ This revision: 2017 March 16
136134

137135
SOFA release 2018-01-30
138136

139-
Copyright (C) 2018 IAU SOFA Board.
137+
Copyright (C) 2018 IAU SOFA Board.
138+
139+
[1]: iau.apcs13.md
140+
[2]: iau.epv00.md
141+
[14]: iau.atciq.md
142+
[15]: iau.aticq.md

0 commit comments

Comments
 (0)