Commit Graph

22 Commits

Author SHA1 Message Date
Don Cross
330b8447f3 Fixed #57 - Finished preamble for Python documentation.
Python documention: corrected internal links in Markdown prefix.
This concludes support for Python documentation fixes.
2019-12-19 13:46:15 -05:00
Don Cross
07e68707a6 Add prefix markdown to Python documentation. 2019-12-19 13:35:56 -05:00
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
98deea4523 Python: Finished coding rotation functions. Need to finish test cases. 2019-12-17 20:32:37 -05:00
Don Cross
bafaa78133 Trimmed trailing whitespace in pydown.py. 2019-12-12 14:53:51 -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
746dbe2409 Python documentation: remove extraneous blank lines from Markdown. 2019-07-17 20:21:36 -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
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
4ba3130ecc Python: experimenting with generation of Markdown documentation. 2019-07-08 21:59:29 -04:00
Don Cross
9384ce69b3 Python: rework apsis kind as an IntEnum called ApsisKind. 2019-07-08 15:59:24 -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
700d3d7870 Starting to create my own custom Python to Markdown converter.
Once again, existing tools are too complicated and don't do what I want.
It's actually easier to create my own tool for this special purpose.
I also want the documentation to be similar in style to the other languages.
2019-07-08 14:25:49 -04:00