summaryrefslogtreecommitdiff
path: root/doc/_extensions/autojsdoc/parser/tests
AgeCommit message (Collapse)Author
2018-02-19[FIX] doc: tokenization of nested generics in JS docstringsXavier Morel
With more than 1 level of generic type, the "closure" of generic parameters would get tokenized by python as a single right shift (>>) rather than two gt (>, >) leading to our own tokenizing pass getting lost and blowing up. Fix by explicitly recognizing and splitting (>>) into (>, >). We could consider writing the entire tokenizer ourselves instead of post-processing Python's but given the entire post-processing function is currently shorter than just Pythons' tokenizer's regexes... Anyway issue found by vsc while trying to write better docstrings.
2017-09-18[ADD] doc: JS document extraction systemXavier Morel
* 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