search

apache / mxnet

Lightweight, Portable, Flexible Distributed/Mobile Deep Learning with Dynamic, Mutation-aware Dataflow Dep Scheduler; for Python, R, Julia, Scala, Go, Javascript and more
https://mxnet.apache.org
Apache License 2.0
20.79k stars 6.79k forks source link

[python docs] gluon.nn.SymbolBlock - multiple issues #16312

Open aaronmarkham opened 5 years ago

aaronmarkham commented 5 years ago

Description

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: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
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.SymbolBlock.rst:2: WARNING: duplicate object description of mxnet.gluon.nn.SymbolBlock, other instance in api/gluon/mxnet.gluon.SymbolBlock, use :noindex: for one of them
/work/mxnet/docs/python_docs/python/build/api/gluon/mxnet.gluon.nn.SymbolBlock.rst:27: WARNING: Field list ends without a blank line; unexpected unindent.

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
mxnet-label-bot commented 5 years ago

Hey, this is the MXNet Label Bot. Thank you for submitting the issue! I will try and suggest some labels so that the appropriate MXNet community members can help resolve it. Here are my recommended label(s): Gluon, Doc