Skip to content

[bugfix] When building the docs in a fresh environment, some compilation errors may occur. #115

@zheliuyu

Description

@zheliuyu

Summary

The usage of the docs is not affected for now. These errors only occur when building in a completely new environment.

TODO: FIX.

Log

# Part1
/root/docs/sources/LLaMA-Factory/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/LLaMA-Factory/source/advanced/npu_installation' [toc.not_readable]
/root/docs/sources/LLaMA-Factory/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/LLaMA-Factory/source/advanced/npu_training' [toc.not_readable]
/root/docs/sources/LLaMA-Factory/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/LLaMA-Factory/source/advanced/distributed' [toc.not_readable]
/root/docs/sources/VeOmni/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/VeOmni/get_started/installation/install_ascend' [toc.not_readable]
/root/docs/sources/VeOmni/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/VeOmni/hardware_support/get_started_npu' [toc.not_readable]
/root/docs/sources/ascend/quick_install.rst:2: WARNING: Title underline too short.


# Part2
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "Version|Filter|n-shot|Metric". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "Value | |Stderr". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "------------------". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "------". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "------". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "-----:". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "-----:". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "mmlu |N/A |none | 0|acc |↑ |0.4336|± |0.0041". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "N/A |none | 0|acc |↑ |0.4064|± |0.0070". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "N/A |none | 0|acc |↑ |0.4796|± |0.0088". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "none | 0|acc |↑ |0.4953|± |0.0089". [docutils]
/root/docs/sources/lm_evaluation/quick_start.rst:99: ERROR: Undefined substitution referenced: "N/A |none | 0|acc |↑ |0.3689|± |0.0085". [docutils]
/root/docs/sources/ms-swift/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/ms-swift/source/BestPractices/NPU-support' [toc.not_readable]
/root/docs/sources/ms-swift/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/ms-swift/source_en/BestPractices/NPU-support' [toc.not_readable]
/root/docs/sources/opencompass/quick_start.rst:98: ERROR: Undefined substitution referenced: "im_end". [docutils]
/root/docs/sources/opencompass/quick_start.rst:98: ERROR: Undefined substitution referenced: "im_start". [docutils]
/root/docs/sources/pytorch/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/pytorch/api_doc' [toc.not_readable]


# Part3
/root/docs/sources/verl/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/verl/ascend_quick_start' [toc.not_readable]
/root/docs/sources/verl/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/verl/ascend_sglang_quick_start' [toc.not_readable]
/root/docs/sources/verl/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/verl/dockerfile_build_guidance' [toc.not_readable]
/root/docs/sources/verl/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/verl/ascend_profiling_en' [toc.not_readable]
/root/docs/sources/verl/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/verl/ascend_profiling_zh' [toc.not_readable]
/root/docs/sources/verl/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/verl/ascend_consistency' [toc.not_readable]


# Part4
/root/docs/sources/transformers/fine-tune.rst:39: WARNING: Lexing literal_block '{\'label\': 0, \'text\': \'My expectations for McDonalds are t rarely high. But for one to still fail so spectacularly...that takes something special!\\\\n\nThe cashier took my friends\\\'s order, then promptly ignored me. I had to force myself in front of a cashier who opened his register to wait on the\nperson BEHIND me. I waited over five minutes for a gigantic order that included precisely one kid\\\'s meal. After watching two people who ordered after\nme be handed their food, I asked where mine was. The manager started yelling at the cashiers for \\\\"serving off their orders\\\\" when they didn\\\'t have\ntheir food. But neither cashier was anywhere near those controls, and the manager was the one serving food to customers and clearing the boards.\\\\nThe\nmanager was rude when giving me my order. She didn\\\'t make sure that I had everything ON MY RECEIPT, and never even had the decency to apologize that\nI felt I was getting poor service.\\\\nI\\\'ve eaten at various McDonalds restaurants for over 30 years. I\\\'ve worked at more than one location. I expect\nbad days, bad moods, and the occasional mistake. But I have yet to have a decent experience at this store. It will remain a place I avoid unless someone\nin my party needs to avoid illness from low blood sugar. Perhaps I should go back to the racially biased service of Steak n Shake instead!\'}' as "shell" resulted in an error at token: "'". Retrying in relaxed mode. [misc.highlighting_failure]
/root/docs/sources/transformers/quick_start.rst:118: WARNING: Lexing literal_block "Good day to you! My name is Housekeeper Helen, and I'm delighted to introduce myself as a friendly and efficient chatbot designed to assist with household tasks and provide helpful information.\nAs a housekeeper, my primary role is to ensure your home is tidy, organized, and comfortable. I'd be happy to help with:\n\n* Cleaning and organization tips\n* Household chore schedules\n* Laundry and ironing guidance\n* Home maintenance advice\n* And any other domestic-related queries you may have!\n\nPlease feel free to ask me any questions or request my assistance with a specific task. I'm here to help make your life easier and your home sparkle!" as "shell" resulted in an error at token: "'". Retrying in relaxed mode. [misc.highlighting_failure]


# Part5
The HTML pages are in _build/html.
root@autodl-container-1vgexf3kfe-f588b883:~/docs# ls
Makefile  README.md  _build  _repos  _static  _templates  conf.py  index.rst  make.bat  requirements.txt  scripts  sources
Fetched: 755container-1vgexf3kfe-f588b883:~/docs# 
Done! Saved to /root/docs/scripts/../_static/ascend_config.json
Preparing generated docs directory...
Copying project documentation...
Copying _repos/verl/docs/ascend_tutorial -> sources/_generated/sources/verl
Copying _repos/verl/docs/ascend_tutorial to sources/_generated/sources/verl
  [WARN] Source directory does not exist or is empty: _repos/verl/docs/ascend_tutorial
Copying _repos/VeOmni/docs -> sources/_generated/sources/VeOmni
Copying _repos/VeOmni/docs to sources/_generated/sources/VeOmni
  [WARN] Source directory does not exist or is empty: _repos/VeOmni/docs
Copying _repos/LLaMA-Factory/docs -> sources/_generated/sources/LLaMA-Factory
Copying _repos/LLaMA-Factory/docs to sources/_generated/sources/LLaMA-Factory
  [WARN] Source directory does not exist or is empty: _repos/LLaMA-Factory/docs
Copying _repos/ms-swift/docs -> sources/_generated/sources/ms-swift
Copying _repos/ms-swift/docs to sources/_generated/sources/ms-swift
  [WARN] Source directory does not exist or is empty: _repos/ms-swift/docs
Syncing ONNX Runtime CANN quick start from upstream...
Synced to sources/_generated/sources/onnxruntime/quick_start.md
Running Sphinx v9.1.0
Warning: _op_plugin_docs module not found. Skipping API documentation generation.
loading translations [zh_CN]... done
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 80 source files that are out of date
updating environment: [new config] 80 added, 0 changed, 0 removed
/root/miniconda3/lib/python3.12/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
  warn("Container node skipped: type={0}".format(mdnode.t))
reading sources... [100%] sources/whisper_cpp/quick_start
/root/docs/sources/LLaMA-Factory/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/LLaMA-Factory/source/advanced/npu_installation' [toc.not_readable]
/root/docs/sources/LLaMA-Factory/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/LLaMA-Factory/source/advanced/npu_training' [toc.not_readable]
/root/docs/sources/LLaMA-Factory/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/LLaMA-Factory/source/advanced/distributed' [toc.not_readable]
/root/docs/sources/VeOmni/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/VeOmni/get_started/installation/install_ascend' [toc.not_readable]
/root/docs/sources/VeOmni/index.rst:4: WARNING: toctree contains reference to nonexisting document 'sources/_generated/sources/VeOmni/hardware_support/get_started_npu' [toc.not_readable]
/root/docs/sources/ascend/quick_install.rst:2: WARNING: Title underline too short.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions