-
-
Notifications
You must be signed in to change notification settings - Fork 167
Fix regression in #81 #93
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
Conversation
c560652
to
f784df6
Compare
Hey, could it be that the double use of .. currentmodule:: causes the issue? your template idk, back then i just knew i needed to include that line and searched for some way to |
Hi, thanks for your quick reply I tried to get rid of my currentmodule but it doesnt work either. It seems it's more complicated than that ; MyClass lies in I think we have no easy way of doing that ; I propose to revert to avoid regressions in lots of python codebases, what do you think ? |
It seems numpy#81 introduced some kind of bug: I have the following rst file documenting MyClass object from ottemplate module: ``` .. currentmodule:: ottemplate .. autosummary:: :toctree: _generated/ :template: class.rst_t MyClass ``` with class.rst_t: ``` {{ objname }} {{ underline }} .. currentmodule:: {{ module }} .. autoclass:: {{ objname }} {% block methods %} .. automethod:: __init__ {% endblock %} ``` results in the following error: ``` following exception was raised: Traceback (most recent call last): File "/home/schueller/.local/lib/python3.5/site-packages/sphinx/ext/autodoc.py", line 551, in import_object __import__(self.modname) ImportError: No module named 'ottemplate.ottemplate.MyClass'; 'ottemplate.ottemplate' is not a package ``` What do you think @sirno ?
Fixes circleci build waiting for the numpydoc fix: numpy/numpydoc#93
ping @sirno |
hey, sorry i was quite busy and am without computer the next couple of days. however, it shouldnt be a problem that you packaged like this since ottemplate.ottemplate.MyClass should still be directly importable from the absolute path. either way. i think reverting is a good plan. i can easily fix my own stuff by manually adding the line so if possible somebody should merge this pr before the next release. |
ping |
@jschueller Understood; just tying together all relevant PRs. |
Looks like this makes sense to revert, thanks @jschueller, all |
Fixes circleci build waiting for the numpydoc fix: numpy/numpydoc#93
Fixes circleci build waiting for the numpydoc fix: numpy/numpydoc#93
It seems #81 introduced some kind of bug:
I have the following rst file documenting MyClass object from ottemplate module:
with class.rst_t:
results in the following error:
I use sphinx latest stable 1.5.5 with python 3.5.2.
What do you think @sirno ?