[Tools] Add documentation generation script #2911
Conversation
| @@ -126,3 +128,5 @@ class AnalogIn { | |||
| #endif | |||
|
|
|||
| #endif | |||
|
|
|||
| /** @}*/ | |||
There was a problem hiding this comment.
Shouldn't this documentation be on the end brace of the matching namespace?
There was a problem hiding this comment.
My script did not automatically find the close-brace of the namespace, and doing so without having a proper parser would be difficult. (I just used a regexp)
|
I might be missing something, but |
screamerbg
changed the title
|
@theotherjimmy Can you add the script to tools/misc/ (not tools root) please? |
|
LGTM for the record |
|
@screamerbg Yes. New commit coming. |
|
Welp GitHub just didn't show it in the "files changed" tab. I can see it if I review each commit individually. |
There was a problem hiding this comment.
The generation script is currently names docs_get.py, but from your PR comment it sounds like it was meant to be named docs_gen.py. Also, running it gives me the following error:
$ python tools/misc/docs_get.py
Traceback (most recent call last):
File "tools/misc/docs_get.py", line 32, in <module>
from tools.toolchains.gcc import GCC_ARM
ImportError: No module named tools.toolchains.gcc
Sounds like you need to add a different directory to the python PATH?
theotherjimmy
force-pushed
the
docs-generation
branch
2 times, most recently
from
6425424 to
4f00d47
Compare
|
@bridadan try now |
There was a problem hiding this comment.
After installing doxygen and getting it into my path, everything seems to have worked (with a bunch of warnings, but still ok!)
@theotherjimmy Part of me thinks we should run the bots on this too, just in case some weird syntax error creeped in? Thoughts?
|
could you configure travis/other CI to generate docs.. |
|
Not sure how useful that is? I guess just to make sure that doc generation doesn't break? |
|
/morph test |
|
at least it doesn't break if we can verify it with CI, that is minimum requirements if you ask from me :). But what I mean that we could upload doxygen documentation directly to S3/XX when PR lands to release branch --> automate documentation generation flow for example.... ;) |
|
/morph test |
theotherjimmy
force-pushed
the
docs-generation
branch
from
4f00d47 to
9261ed4
Compare
|
@sg- it no longer touches the excluded header files. |
Result: ABORTEDYour command has finished executing! Here's what you wrote!
|
|
/morph test |
Result: SUCCESSYour command has finished executing! Here's what you wrote!
Outputmbed Build Number: 1053 All builds and test passed! |
|
Ping @geky |
Description
Generate documentation at the touch of a command line invocation.
Status
READY
Migrations
RTFM. (NO)
Reviews
Steps to test or reproduce
python tools/misc/docs_gen.pyfrom the mbed-os root