Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the Warnings with duplicate object description when building Qlib's documentation #1353

Conversation

MaximSmolskiy
Copy link
Contributor

Description

Fix all WARNING: duplicate object description of ..., other instance in ..., use :noindex: for one of them. Total number of warnings decreased by about 160

Motivation and Context

Related to #1345

How Has This Been Tested?

  • Pass the test by running: pytest qlib/tests/test_all_pipeline.py under upper directory of qlib.
  • If you are adding a new feature, test on your own test scripts.

Screenshots of Test Results (if appropriate):

  1. Pipeline test:
  2. Your own tests:

Types of changes

  • Fix bugs
  • Add new feature
  • Update documentation

@you-n-g
Copy link
Collaborator

you-n-g commented Nov 14, 2022

Thanks!
It looks great!

@you-n-g you-n-g merged commit 8802653 into microsoft:main Nov 14, 2022
@MaximSmolskiy MaximSmolskiy deleted the fix-the-Warnings-with-duplicate-object-description-when-building-Qlibs-documentation branch November 14, 2022 11:05
@you-n-g you-n-g added the documentation Improvements or additions to documentation label Dec 9, 2022
qianyun210603 pushed a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
…'s documentation (microsoft#1353)

* Add :noindex: to docs/advanced/task_management.rst

* Add :noindex: to docs/component/data.rst

* Add :noindex: to docs/component/model.rst

* Add :noindex: to docs/component/online.rst

* Add :noindex: to docs/component/recorder.rst

* Add :noindex: to docs/component/report.rst

* Retest
qianyun210603 pushed a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
…'s documentation (microsoft#1353)

* Add :noindex: to docs/advanced/task_management.rst

* Add :noindex: to docs/component/data.rst

* Add :noindex: to docs/component/model.rst

* Add :noindex: to docs/component/online.rst

* Add :noindex: to docs/component/recorder.rst

* Add :noindex: to docs/component/report.rst

* Retest
qianyun210603 pushed a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
…'s documentation (microsoft#1353)

* Add :noindex: to docs/advanced/task_management.rst

* Add :noindex: to docs/component/data.rst

* Add :noindex: to docs/component/model.rst

* Add :noindex: to docs/component/online.rst

* Add :noindex: to docs/component/recorder.rst

* Add :noindex: to docs/component/report.rst

* Retest
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants