numpydoc icon indicating copy to clipboard operation
numpydoc copied to clipboard

Remove Numpy*Domains?

Open jnothman opened this issue 8 years ago • 3 comments

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.

jnothman avatar Nov 01 '17 22:11 jnothman

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.

pv avatar Nov 01 '17 23:11 pv

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

jnothman avatar Nov 01 '17 23:11 jnothman

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

jnothman avatar Nov 01 '17 23:11 jnothman