Python docs: support documentation of enumerated types.

This commit is contained in:
Don Cross
2019-07-12 19:58:14 -04:00
parent 033a2a1b53
commit f97096105a
4 changed files with 289 additions and 61 deletions

View File

@@ -11,6 +11,12 @@
**Represents the geographic location of an observer on the surface of the Earth.**
| Type | Parameter | Description |
| --- | --- | --- |
| `float` | `latitude` | Geographic latitude in degrees north of the equator. |
| `float` | `longitude` | Geographic longitude in degrees east of the prime meridian at Greenwich, England. |
| `float` | `height` | Elevation above sea level in meters. |
@@ -21,6 +27,10 @@
**Represents a date and time used for performing astronomy calculations.**
All calculations performed by Astronomy Engine are based on
dates and times represented by `Time` objects.
| Type | Parameter | Description |
| --- | --- | --- |
| `float` | `ut` | UT1/UTC number of days since noon on January 1, 2000. See the `ut` attribute of this class for more details. |
@@ -32,6 +42,95 @@
---
<a name="enumerations"></a>
## Enumerated Types
---
<a name="ApsisKind"></a>
### ApsisKind
**Represents whether a satellite is at a closest or farthest point in its orbit.**
An apsis is a point in a satellite's orbit that is closest to,
or farthest from, the body it orbits (its primary).
`ApsisKind` is an enumerated type that indicates which of these
two cases applies to a particular apsis event.
| Value | Description |
| --- | --- |
| `Pericenter` | The satellite is at its closest point to its primary. |
| `Apocenter` | The satellite is at its farthest point from its primary. |
| `Invalid` | A placeholder for an undefined, unknown, or invalid apsis. |
---
<a name="Body"></a>
### Body
**The celestial bodies supported by Astronomy Engine calculations.**
| Value | Description |
| --- | --- |
| `Invalid` | An unknown, invalid, or undefined celestial body. |
| `Mercury` | The planet Mercury. |
| `Venus` | The planet Venus. |
| `Earth` | The planet Earth. |
| `Mars` | The planet Mars. |
| `Jupiter` | The planet Jupiter. |
| `Saturn` | The planet Saturn. |
| `Uranus` | The planet Uranus. |
| `Neptune` | The planet Neptune. |
| `Pluto` | The planet Pluto. |
| `Sun` | The Sun. |
| `Moon` | The Earth's moon. |
---
<a name="Direction"></a>
### Direction
**Indicates whether a body is rising above or setting below the horizon.**
Specifies the direction of a rising or setting event for a body.
For example, `Direction.Rise` is used to find sunrise times,
and `Direction.Set` is used to find sunset times.
| Value | Description |
| --- | --- |
| `Rise` | First appearance of a body as it rises above the horizon. |
| `Set` | Last appearance of a body as it sinks below the horizon. |
---
<a name="Refraction"></a>
### Refraction
**Selects if/how to correct for atmospheric refraction.**
Some functions allow enabling or disabling atmospheric refraction
for the calculated apparent position of a celestial body
as seen by an observer on the surface of the Earth.
| Value | Description |
| --- | --- |
| `Airless` | No atmospheric refraction correction. |
| `Normal` | Recommended correction for standard atmospheric refraction. |
| `JplHorizons` | Used only for compatibility testing with JPL Horizons online tool. |
---
<a name="functions"></a>
@@ -45,6 +144,10 @@
**Finds the Body enumeration value, given the name of a body.**
>>> astronomy.BodyCode('Mars')
<Body.Mars: 3>
| Type | Parameter | Description |
| --- | --- | --- |
| `str` | `name` | The common English name of a supported celestial body. |
@@ -59,6 +162,16 @@
**Calculates the geocentric position of the Moon at a given time.**
Given a time of observation, calculates the Moon's position as a vector.
The vector gives the location of the Moon's center relative to the Earth's center
with x-, y-, and z-components measured in astronomical units.
This algorithm is based on Nautical Almanac Office's *Improved Lunar Ephemeris* of 1954,
which in turn derives from E. W. Brown's lunar theories from the early twentieth century.
It is adapted from Turbo Pascal code from the book
[Astronomy on the Personal Computer](https://www.springer.com/us/book/9783540672210)
by Montenbruck and Pfleger.
| Type | Parameter | Description |
| --- | --- | --- |
| [`Time`](#Time) | `time` | The date and time for which to calculate the Moon's position. |