-
- Downloads
[ADD] doc: JS document extraction system
* Fix a bunch of ill-documented/incomplete/incorrect method docs * add start of Sphinx extension to extract & integrate jsdoc into Sphinx documentation: - parse JS files (and don't blow up), uses a fork of pyjsparser as the project currently does not parse comments - extract cross-module dependency information - parse JsDoc comments using pyjsdoc and infer structure from code & jsdoc - ``ast`` CLI printing a simplified AST of the input files - ``dependencies`` creating a dependency graph of either all modules in the provided input files or the modules matching the specified filters (warning: will not work if missing dependencies), generates a .dot file - ``extractor`` generating a plain text module documentation (mix of rst and markdown styles, not anything formal) * sphinx extension with an "automodule" directive taking a module name and generating the documentation for it
Showing
- doc/_extensions/autojsdoc/README.rst 87 additions, 0 deletionsdoc/_extensions/autojsdoc/README.rst
- doc/_extensions/autojsdoc/__init__.py 1 addition, 0 deletionsdoc/_extensions/autojsdoc/__init__.py
- doc/_extensions/autojsdoc/__main__.py 154 additions, 0 deletionsdoc/_extensions/autojsdoc/__main__.py
- doc/_extensions/autojsdoc/ext/__init__.py 13 additions, 0 deletionsdoc/_extensions/autojsdoc/ext/__init__.py
- doc/_extensions/autojsdoc/ext/directives.py 686 additions, 0 deletionsdoc/_extensions/autojsdoc/ext/directives.py
- doc/_extensions/autojsdoc/ext/extractor.py 87 additions, 0 deletionsdoc/_extensions/autojsdoc/ext/extractor.py
- doc/_extensions/autojsdoc/parser/__init__.py 1 addition, 0 deletionsdoc/_extensions/autojsdoc/parser/__init__.py
- doc/_extensions/autojsdoc/parser/jsdoc.py 324 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/jsdoc.py
- doc/_extensions/autojsdoc/parser/parser.py 552 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/parser.py
- doc/_extensions/autojsdoc/parser/tests/README.rst 6 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/tests/README.rst
- doc/_extensions/autojsdoc/parser/tests/support.py 73 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/tests/support.py
- doc/_extensions/autojsdoc/parser/tests/test_class.py 227 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/tests/test_class.py
- doc/_extensions/autojsdoc/parser/tests/test_crap.py 75 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/tests/test_crap.py
- doc/_extensions/autojsdoc/parser/tests/test_module.py 173 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/tests/test_module.py
- doc/_extensions/autojsdoc/parser/tests/test_namespace.py 177 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/tests/test_namespace.py
- doc/_extensions/autojsdoc/parser/tests/test_params.py 116 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/tests/test_params.py
- doc/_extensions/autojsdoc/parser/tests/test_typespec.py 81 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/tests/test_typespec.py
- doc/_extensions/autojsdoc/parser/types.py 191 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/types.py
- doc/_extensions/autojsdoc/parser/utils.py 295 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/utils.py
- doc/_extensions/autojsdoc/parser/visitor.py 126 additions, 0 deletionsdoc/_extensions/autojsdoc/parser/visitor.py
Loading
Please register or sign in to comment