Skip to content

Added ..currentmodule:: before ..autosummary:: #81

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

Merged
merged 1 commit into from
Dec 27, 2016
Merged

Added ..currentmodule:: before ..autosummary:: #81

merged 1 commit into from
Dec 27, 2016

Conversation

sirno
Copy link
Contributor

@sirno sirno commented Dec 13, 2016

This addition solves an issue I had with the method section generated by numpydoc

@sirno
Copy link
Contributor Author

sirno commented Dec 13, 2016

this resolves #80

@stefanv
Copy link
Contributor

stefanv commented Dec 13, 2016

Can anyone else confirm this issue?

@rgommers rgommers added this to the v0.7.0 milestone Dec 27, 2016
@rgommers
Copy link
Member

I've confirmed that this fixes the example given in gh-80 (which looks like a valid way to use autoclass) and that it doesn't cause any problems for the scipy doc build. So merging.

Thanks @sirno

@rgommers
Copy link
Member

Hmm, this passed its tests earlier but is now broken after merging says TravisCI. Will investigate.

rgommers pushed a commit to rgommers/numpydoc that referenced this pull request Dec 27, 2016
@rgommers
Copy link
Member

Fix in gh-86. @sirno can you please double check that?

pv added a commit that referenced this pull request Mar 5, 2017
jschueller added a commit to jschueller/numpydoc that referenced this pull request May 10, 2017
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 ?
@jschueller jschueller mentioned this pull request May 10, 2017
jschueller added a commit to jschueller/numpydoc that referenced this pull request May 10, 2017
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 ?
jschueller added a commit to jschueller/numpydoc that referenced this pull request May 10, 2017
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 ?
jschueller added a commit to jschueller/numpydoc that referenced this pull request May 11, 2017
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 ?
rgommers added a commit that referenced this pull request Jun 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants