[WIP] Work on writing a parser using the textmate grammar backend. - Githubissues

sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code

http://sphinxcontrib-matlabdomain.readthedocs.io/

Other

70 stars 46 forks source link

[WIP] Work on writing a parser using the textmate grammar backend. #253

Closed apozharski closed 4 months ago

apozharski commented 4 months ago

Currently includes support for:

Enumerations
- Including support for constructor arguments and docstring comments
Properties
- Including support for validator syntax and docstring comments
Methods/Functions
- Including support for arguments

Things left to do:

Properly handle class, method, and property attributes: Blocked currently by https://github.com/watermarkhu/textmate-grammar-python/issues/67 and similar issues with method and property attribute parsing.
clean up script used for testing and perhaps extract function parser.

joeced commented 4 months ago

Please install pre-commit, which will among others run black formatter. Set up a virtual environment and then run:

pip install -r dev-requirements.txt
pre-commit install