search

mindspore-ai / docs

MindSpore document
Apache License 2.0
158 stars 27 forks source link

Lots of warnings showed up when building mindspore-docs #5

Closed hwhsu1231 closed 6 days ago

hwhsu1231 commented 6 days ago

Environment

Hardware Environment(Ascend/GPU/CPU):

/device cpu

Software Environment:

Describe the current behavior

I tried to build mindspore documentation by following the instructions. However, there are lots of warnings showing up after completing the buliding. For example:

WARNING: html_static_path entry '_static' does not exist
WARNING: mindspore.Tensor.H
WARNING: mindspore.Tensor.T
WARNING: mindspore.Tensor.dtype
WARNING: mindspore.Tensor.has_init
WARNING: mindspore.Tensor.itemsize
WARNING: mindspore.Tensor.mH
WARNING: mindspore.Tensor.mT
WARNING: mindspore.Tensor.nbytes
WARNING: mindspore.Tensor.ndim
WARNING: mindspore.Tensor.shape
WARNING: mindspore.Tensor.size
WARNING: mindspore.Tensor.strides
WARNING: mindspore.dataset.Dataset.input_indexs
ModuleNotFoundError: No module named 'mindspore.dataset.config'
viewcode can't import mindspore.dataset.config, failed with error "No module named 'mindspore.dataset.config'"
...
Didn't find mindspore.communication.HCCL_WORLD_COMM_GROUP in mindspore.communication
WARNING: Failed to get a function signature for mindspore.numpy.mgrid: <mindspore.numpy.array_creations.MGridClass object at 0x7965eb26e510> is not a callable object
WARNING: Failed to get a function signature for mindspore.numpy.ogrid: <mindspore.numpy.array_creations.OGridClass object at 0x7965eb26e550> is not a callable object
/home/hwhsu1231/Repo/testing/mindspore-docs/.venv/lib/python3.7/site-packages/mindspore/ops/function/debug_func.py:docstring of mindspore.ops.function.debug_func.print_:: ERROR: Unknown target name: "print".
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/api_python/samples/dataset/dataset_gallery.ipynb: WARNING: document isn't included in any toctree
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/api_python/samples/dataset/text_gallery.ipynb: WARNING: document isn't included in any toctree
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/api_python/samples/dataset/vision_gallery.ipynb: WARNING: document isn't included in any toctree
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/api_python/samples/ops/communicate_ops.md: WARNING: document isn't included in any toctree
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/api_python/samples/rewrite/rewrite_tutorial.md: WARNING: document isn't included in any toctree
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/design/mindir.md: WARNING: document isn't included in any toctree
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/note/api_mapping/pytorch_diff/AGNEWS.md: WARNING: document isn't included in any toctree
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/note/api_mapping/pytorch_diff/AdaMax.md: WARNING: document isn't included in any toctree
/home/hwhsu1231/Repo/testing/mindspore-docs/docs/mindspore/source_en/note/api_mapping/pytorch_diff/Adagrad.md: WARNING: document isn't included in any toctree
...

Describe the expected behavior

No warning showed up. And the sphinx theme should be the same as MindSpore website.

Steps to reproduce the issue

  1. Clone the mindspore/docs repository:

    git clone --depth=1 --branch=r2.2 https://gitee.com/mindspore/docs.git mindspore-docs
cd mindspore-docs

  2. Create and activate the Conda Environment:

    conda create -c conda-forge -p ./.venv python=3.7 -y
conda activate ./.venv

  3. Clone the mindspore/mindspore repository and set MS_PATH environment variable:

    git clone --depth=1 --branch=r2.2 --recursive https://gitee.com/mindspore/mindspore.git
export MS_PATH=$(pwd)/mindspore

  4. Install pandoc and mindspore by conda:

    conda install pandoc mindspore=2.2.14 -c mindspore -c conda-forge -y

  5. Install regex and requirements.txt by pip:

    cd docs/mindspore
pip install regex -r requirements.txt

  6. Build English HTML Documentation:

    LANG=en_US.UTF-8 make html SPHINXOPTS=-v SOURCEDIR=source_en BUILDDIR=build_en

Related log / screenshot

log-build-mindspore-docs-wanrings.txt

Screenshot_20240703_125759

Special notes for this issue

hwhsu1231 commented 6 days ago

Moved to: https://gitee.com/mindspore/docs/issues/IAA9RE