Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sphinxcontrib-matlabdomain 0.19.0 #993

Open
joeced opened this issue Apr 28, 2023 · 4 comments
Open

sphinxcontrib-matlabdomain 0.19.0 #993

joeced opened this issue Apr 28, 2023 · 4 comments
Labels
documentation 📄 Improvements or additions to documentation

Comments

@joeced
Copy link

joeced commented Apr 28, 2023

Hi

I'm the main author and maintainer of the sphinxcontrib-matlabdomain Python package.
I just finished a major update of the extension and added a new configuration option:
matlab_short_links. In short (no pun intended), it's finally possible to render and link to MATLAB classes and function by the name they have in MATLAB.

Instead of src.package.AmazingClass, you now get package.AmazingClass. Further, the linking to that is :class:`package.AmazingClass`.

As you are a major user of the extension, I would appreciate if you could take the time to test if the new release works as expected. In your requirements.txt, please specify:

sphinxcontrib-matlabdomain==0.19.0rc1

If you need any help or discover issues please reach out to me in this thread.

Thanks!

@github-actions
Copy link

Thank you for your issue. Give us a little time to review it.

PS. You might want to check the FAQ if you haven't done so already.

This is an automated reply, generated by FAQtory

@Remi-Gau
Copy link
Contributor

@joeced thanks for reaching out.

I was actually following that new feature from a distance on your repo.

Will try things out on this and a couple of other projects and let you know how it goes.

@joeced
Copy link
Author

joeced commented Apr 29, 2023

Thanks for testing it out. I really appreciate that. I would like to iron out issues before making a real release

@joeced joeced changed the title sphinxcontrib-matlabdomain 0.19.0 pre-release sphinxcontrib-matlabdomain 0.19.0 May 16, 2023
@joeced
Copy link
Author

joeced commented May 16, 2023

I now released the version after testing it on a larger project.

sphinxcontrib-matlabdomain==0.19.0

@Remi-Gau Remi-Gau added the documentation 📄 Improvements or additions to documentation label Jun 18, 2023
@Remi-Gau Remi-Gau added this to the v3.2.0 milestone Jun 25, 2023
@Remi-Gau Remi-Gau removed this from the v3.2.0 milestone Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📄 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants