Add option matlab_short_links
#171
Conversation
Working on getting more MATLAB like rendering and links. Rather than `target.+package.ClassBar`, it will displayed and referenced as `package.ClassBar`.
README.rst
Outdated
| Shorten all class, package and functions to the minimum length. This assumes | ||
| that everything is in the path as we would expect it in MATLAB. This should | ||
| resemble a more MATLAB-like presentation. Default is ``True``. | ||
| *Added in Version 0.17.0.* |
There was a problem hiding this comment.
Should be fixed now.
|
Beautiful! I started working on this at the end of last week, but you got much further much more quickly than me. I'll play around with this a bit more and comment as soon as I have anything. But, assuming this works consistently as intended, I'd vote to release it ASAP, as it's a huge step forward. Thanks! |
|
It's going forward. However, as I learn more, I also discover other issues. For instance, linking to baseclasses which seems to be broken. I'm away from a computer for a week from Wednesday, so there will be limited progress. |
First steps towards parsing the entire `base_dir` for MATLAB entities. All entities are now stored in `MatObject.entities` instead of a dict. A `MatModule` object represents a directory. It will contain: * MatModule (directories: regular, package or classfolder) * MatClass (class m-files) * MatFunction (function m-files) * MatScript (script m-files) * MatApplication (mlapps)
- import_object is so much simpler now. - `MatModule.safe_getmembers` is now the only place where we traverse directories. - MatClass.__bases__ is so much simpler now. - All use of "modules" replaced with entities_table. - Started fixing tests.
reset entities_tables.
|
A short progress report. It's slow and steady getting closer. I can now render objects in the root folder 🥳
However, I still have a few details to iron out around base class linking. |
|
This is great. Thanks. I've been looking at some of this code with a view to starting work on #178. And I agree that you're making that easier. |
|
@rdzman It's almost ready to merge to master. I need to fix tests asserting class rendering. |
If a class has nothing to document we added an empty "container", resulting in: ` ERROR: Content block expected for the "container" directive; none found` Added `test_docs_automodule` to test recursively listing all members.
Working on getting more MATLAB like rendering and links.
Rather than
target.+package.ClassBar, it will displayed and referenced aspackage.ClassBar.