Don Cross
fce1468a1c
Fixed #55 - Python documentation internal links translated to Markdown.
...
pydown.py now searches description text for internal links
and expands them properly for Markdown file README.md.
For example: "#Body" ==> "[`Body`](#Body)".
Fixed a couple of incorrect "Astronomy_..." names in Python docs.
2019-12-18 17:07:00 -05:00
Don Cross
7040ff8684
Cleaned up documented return types for Python functions.
...
Never use pound-signs inside documentation for Python return types.
Automatically create internal link just like for function parameter types.
Added special case logic in pydown.py for "Time or `None`".
Fixed minor documentation mistakes in JS version.
2019-12-18 16:53:13 -05:00
Don Cross
e168f37ac5
Python: Finished rotation logic and unit tests.
...
I thought I had finished the rotation functions last time,
but I missed a couple of them. Finishing the unit tests
revealed that, thankfully.
2019-12-18 10:05:00 -05:00
Don Cross
98deea4523
Python: Finished coding rotation functions. Need to finish test cases.
2019-12-17 20:32:37 -05:00
Don Cross
85d9113f77
Python: Added more rotation functions and unit tests.
2019-12-15 21:24:32 -05:00
Don Cross
d572edb10f
Python: Implemented Rotation_ECL_EQJ.
2019-12-15 20:41:03 -05:00
Don Cross
126cc04d1d
Python: Implemented CombineRotation.
2019-12-15 20:29:41 -05:00
Don Cross
8c590e4449
Python: implemented InverseRotation function. Cleaned up trailing whitespace.
...
Also added missing check in Python apsis test where
I did not verify that each apsis kind was correct.
2019-12-15 20:23:35 -05:00
Don Cross
92cc2d9783
Python: starting to implement rotation functions and associated unit tests.
2019-12-15 19:51:30 -05:00
Don Cross
4a449cc0a1
Python: InverseRefractionAngle, RotateVector. Minor doc fixes.
2019-12-15 13:11:47 -05:00
Don Cross
6440743052
Python: Added function RefractionAngle.
...
Separate the calculation of refraction angle from the Horizon function.
Added missing documentation for the parameters of the Horizon function.
Added definition of class Spherical. Not yet used, but soon will be.
2019-12-15 12:25:17 -05:00
Don Cross
ab8d8ba295
Python: Starting to port new rotation code.
...
Split _precession into _precession_rot/_precession.
Split _nutation into _nutation_rot/_nutation.
Removed trailing whitespace from readme.
2019-12-15 11:34:16 -05:00
Don Cross
ab648ac6ab
Finished first pass of Python documentation.
...
Also make pydown.py generate an error, not just a warning,
for missing documentation, now that all the documentation is filled out.
2019-07-25 23:00:53 -04:00
Don Cross
44084cdf20
Python: added more documentation.
2019-07-19 21:33:19 -04:00
Don Cross
c64880a789
Python: added documentation for function SearchRiseSet.
2019-07-19 21:23:52 -04:00
Don Cross
91e4c7c8d2
Python: added documentation for function SearchHourAngle.
2019-07-19 21:11:54 -04:00
Don Cross
f7bda9890c
Python: added documentation for function SearchPeakMagnitude.
2019-07-19 21:05:19 -04:00
Don Cross
972e43e952
Python: added documentation for function Illumination.
2019-07-19 21:01:13 -04:00
Don Cross
712f334146
Python: added documentation for class IlluminationInfo.
2019-07-19 20:57:20 -04:00
Don Cross
3ad7c7d9ec
Python: Documented moon quarter type and functions.
2019-07-17 20:17:04 -04:00
Don Cross
8287a211a9
Python: added more documentation.
2019-07-17 20:09:34 -04:00
Don Cross
453e06e943
More documentation work.
...
In C code, replaced HTML italics with Markdown emphasis markers.
Added warnings for Python symbols with missing documentation.
Documented Python class Apsis.
2019-07-17 19:46:33 -04:00
Don Cross
8a18cdc58a
Python: include documentation about function return values in Markdown.
2019-07-13 17:48:15 -04:00
Don Cross
7721f7a735
Python: added documentation for function SearchRelativeLongitude.
2019-07-13 17:02:39 -04:00
Don Cross
0d94f03f64
Added lots more Python documentation.
...
Changed visibility from a string 'morning'/'evening' to enum type.
Was not testing visibility was correct; now test.py does that.
Corrected a couple of minor things in C documentation.
2019-07-13 16:46:24 -04:00
Don Cross
c0b4d28805
Python: adding support for documenting class member functions.
2019-07-12 21:20:02 -04:00
Don Cross
959ea8d048
Python: generate markdown for error types.
2019-07-12 20:53:16 -04:00
Don Cross
f97096105a
Python docs: support documentation of enumerated types.
2019-07-12 19:58:14 -04:00
Don Cross
033a2a1b53
pydown: Split classes into regular classes, enums, and errors.
...
Will generate different Markdown for my regular classes,
enumerated types, and error types.
Found out that 'from enum import IntEnum' pulls IntEnum
into the astronomy module and causes us to try to generate
documentation for it. Just keep it in the enum module.
Removed spurious dump of JavaScript README.md when verify_clean
fails.
2019-07-10 21:57:07 -04:00
Don Cross
c7210a108f
Python: replace _DEG2RAD, _RAD2DEG constants with math functions.
2019-07-09 22:09:53 -04:00
Don Cross
fdbad8a252
Python type annotations are causing problems.
...
I'm not going to use type annotations in function signatures
because they are causing more problems than they are worth.
The last straw was that different versions of Python don't
generate the same text representation. This broke my Travis CI
tests.
2019-07-09 18:16:04 -04:00
Don Cross
e169f79fc8
Baby step in converting Python docstrings to Markdown.
2019-07-09 17:02:56 -04:00
Don Cross
4ba3130ecc
Python: experimenting with generation of Markdown documentation.
2019-07-08 21:59:29 -04:00
Don Cross
d66fc5a9ff
Python: converted refraction types to enumerated type Refraction.
2019-07-08 16:18:34 -04:00
Don Cross
f381740976
Python: Convert rise/set direction kinds to an enumerated type Direction.
2019-07-08 16:05:56 -04:00
Don Cross
9384ce69b3
Python: rework apsis kind as an IntEnum called ApsisKind.
2019-07-08 15:59:24 -04:00
Don Cross
3ea7237e3f
Python: eliminate BodyName array; just use IntEnum functionality.
2019-07-08 15:51:10 -04:00
Don Cross
b3e6f185b6
Reworking Python body codes as enumerated type Body.
...
This will help documentation generator pydown.py organize
body codes and other similar enumerations together as classes.
2019-07-08 15:37:56 -04:00
Don Cross
bbd79d7e33
Following "NumPy style" Python docstrings.
...
I will probably need to create my own tool for generating
Markdown from these comments. None of the tools I see online
do quite what I want.
2019-07-07 20:59:20 -04:00
Don Cross
ce3d709d5e
Adding a little more Python documentation.
2019-07-07 17:42:21 -04:00
Don Cross
cb82749aec
Starting to work on Python documentation.
2019-07-07 14:56:04 -04:00
Don Cross
aa0561a534
Trim trailing whitespace from all generated source.
2019-07-07 14:05:49 -04:00
Don Cross
78d43589ff
Generate C iau2000b data from file.
2019-07-06 20:49:11 -04:00
Don Cross
f390fc9201
Generate C CalcMoon AddSol statements from data file.
...
Use the same data file that I generate AddSol for Python
to also generate them in the C source code.
2019-07-06 18:08:07 -04:00
Don Cross
20f87859d8
Moved AddSol data into a data file, so data can be shared across languages.
2019-07-06 17:50:45 -04:00
Don Cross
d750c61337
Python: Moved iau2000b and CalcMoon AddSol data into codegen phase.
...
Now the code generator knows how to optimize and inject these
two calculations into the Python code.
2019-07-06 17:29:34 -04:00
Don Cross
ccf8ab041b
Made generated code in _iau2000b a little prettier.
...
Instead of (a + -b*t), generate (a - b*t).
2019-07-05 08:33:05 -04:00
Don Cross
b4b97935c3
_iau2000b: eliminate a few assignment statements.
2019-07-05 08:31:18 -04:00
Don Cross
36482b7b37
Python _iau2000b: remove fmod calls. riseset 17.0 seconds.
2019-07-05 08:28:07 -04:00
Don Cross
a2183214f1
riseset 17.85 seconds: more optimization of _iau2000b.
2019-07-04 22:16:52 -04:00