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
746dbe2409
Python documentation: remove extraneous blank lines from Markdown.
2019-07-17 20:21:36 -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
00a80bd45a
Python: escape examples as code blocks in Markdown.
2019-07-12 20:04:15 -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
1834b18ca0
pydown: Making a little progress converting Python docstrings to Markdown.
2019-07-10 20:19:26 -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
284894c7e1
Updated Windows build process.
...
Fixed C compiler warnings that show up on Windows but not Linux.
Trim trailing whitespace for target code.
Generate Python documentation.
2019-07-09 16:35:15 -04:00
Don Cross
4ba3130ecc
Python: experimenting with generation of Markdown documentation.
2019-07-08 21:59:29 -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
0e5dd8cee9
Include members-of-members in Python documentation.
2019-07-07 17:43:46 -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
