DOC: Silence many sphinx warnings #11347
Conversation
doc/source/about.rst
Outdated
| as a replacement for *Numeric*. It also adds the features introduced | ||
| by *Numarray* and can also be used to replace *Numarray*. | ||
| NumPy derives from the :doc:`old Numerice <reference/routines.oldnumeric>` code | ||
| base and can be used as a replacement for *Numeric*. It also adds the features |
There was a problem hiding this comment.
It is not a drop in replacement at this point, as the compatibility module has been removed.
There was a problem hiding this comment.
We should probably put the compatibility module somewhere.
doc/source/about.rst
Outdated
| NumPy derives from the old *Numeric* code base and can be used | ||
| as a replacement for *Numeric*. It also adds the features introduced | ||
| by *Numarray* and can also be used to replace *Numarray*. | ||
| NumPy derives from the :doc:`old Numerice <reference/routines.oldnumeric>` code |
numpy/lib/function_base.py
Outdated
| @@ -3543,7 +3543,7 @@ def percentile(a, q, axis=None, out=None, | |||
| def quantile(a, q, axis=None, out=None, | |||
| overwrite_input=False, interpolation='linear', keepdims=False): | |||
| """ | |||
| Compute the `q`th quantile of the data along the specified axis. | |||
| Compute the qth quantile of the data along the specified axis. | |||
There was a problem hiding this comment.
Alternate form "q-th", which seems pretty popular.
There was a problem hiding this comment.
change all qth and qth to q-th
| @@ -1,3 +1,5 @@ | |||
| :orphan: | |||
There was a problem hiding this comment.
better to just remove this file and the oldnumeric one.
|
+1, seems a small enough hack that it's worth putting that in until the numpydoc issue is resolved. would be good to have a tracking issue somewhere, so that once numpydoc is fixed we can remove the orphan directives again |
|
numpy/numpydoc#69 refers to the |
|
Would be nice to merge this, it makes reviewing warnings in subsequent PR DOC changes much more manageable |
|
LGTM now, merged. Thanks @mattip |
Fixes #11316, although it would be better to fix numpy/numpydoc#69 in a different way.
The
:orphan:tag was made specifically to silence this warning. It would be better to find a way forautosummaryto create links to method- and attribute-specific subpages without needing anything in the templates.Additionally, now that the
make htmloutput is cleaner, I fixed a number of small documentation problems