You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2019/09/27 23:48:26 UTC
[GitHub] [incubator-mxnet] aaronmarkham opened a new issue #16311: [python
docs] gluon.nn.HybridBlock - multiple duplicate object description issues
aaronmarkham opened a new issue #16311: [python docs] gluon.nn.HybridBlock - multiple duplicate object description issues
URL: https://github.com/apache/incubator-mxnet/issues/16311
## Description
Guidance is needed before solving these duplicate object Sphinx issues - what is expected in the documentation? Only show things like `register_child` in the `HybridBlock`? Just adding `:noindex:` as suggested by the warning output may have undesired results in the docs output.
Sphinx builds of the Python API docs have the following warning(s):
```
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:2: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:88: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.register_child, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:95: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.hybridize, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:111: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.cast, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:120: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.infer_shape, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:126: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.infer_type, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:132: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.export, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:148: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.register_op_hook, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:159: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.forward, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:166: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.hybrid_forward, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:177: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.apply, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:189: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.collect_params, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:213: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.initialize, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:230: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.load_parameters, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:257: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.load_params, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:275: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.name, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:281: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.name_scope, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:295: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.params, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:302: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.prefix, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:308: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.register_forward_hook, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:323: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.register_forward_pre_hook, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:338: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.save_parameters, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:355: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.save_params, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.HybridBlock.rst:367: WARNING: duplicate object description of mxnet.gluon.nn.HybridBlock.summary, other instance in api/gluon/mxnet.gluon.HybridBlock, use :noindex: for one of them
```
## How to reproduce
You can run into the problem following these steps.
1. Run a "lite" binary build.
```
ci/build.py --docker-registry mxnetci --platform ubuntu_cpu_lite /work/runtime_functions.sh build_ubuntu_cpu_docs
```
2. Run the Python API docs build:
```
ci/build.py --docker-registry mxnetci --platform ubuntu_cpu_python /work/runtime_functions.sh build_python_docs
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services