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
