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

Remove Numpy*Domains? #138

Open
jnothman opened this issue Nov 1, 2017 · 3 comments
Open

Remove Numpy*Domains? #138

jnothman opened this issue Nov 1, 2017 · 3 comments

Comments

@jnothman
Copy link
Member

jnothman commented Nov 1, 2017

From #134:

Some tracing tells me that wrap_mangling_directives results in NumpyPythonDomain's directives being used to handle py:class, py:function, etc. I find it hard to believe that that's the intention.

Do these domains remain relevant? I can't see any reference to them in the numpy or scipy repositories currently. I see that @pv commented on their likely irrelevance in 2012.

@pv
Copy link
Member

pv commented Nov 1, 2017

Yes, probably the self.directives dictionary should be copied.

If you want to write documentation in numpydoc syntax using the sphinx .. function:: way instead of getting them from docstrings via autodoc, then a separate domain is the solution. I don't know if they are used in the wild, but on the other hand supporting them is not that expensive.

@jnothman
Copy link
Member Author

jnothman commented Nov 1, 2017

Do you think that's what's happening? It's overwriting the base directives?

@jnothman
Copy link
Member Author

jnothman commented Nov 1, 2017

If there were tests for this, I'd be better assured when trying that change... :\

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants