Fix the Warnings in rst files when building Qlib's documentation by MaximSmolskiy · Pull Request #1349 · microsoft/qlib

MaximSmolskiy · 2022-11-12T21:49:37Z

Fix all warnings in rst files.

Description

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):

Pipeline test:
Your own tests:

Types of changes

Fix bugs
Add new feature
Update documentation

MaximSmolskiy · 2022-11-12T21:50:29Z

@microsoft-github-policy-service agree

you-n-g · 2022-11-13T11:25:26Z

docs/advanced/task_management.rst


 This whole process can be used in `Online Serving <../component/online.html>`_.

-An example of the entire process is shown `here <https://github.com/microsoft/qlib/tree/main/examples/model_rolling/task_manager_rolling.py>`_.


Why two underscores are necessary here?

I didn't find any reference in rst docs

Could you please share me any related references?
Thanks

Previous version (with one underscore) raises WARNING: Duplicate explicit target name: "..."., I found the solution here

@MaximSmolskiy
It really helpful to me.
Thanks!

you-n-g · 2022-11-13T11:37:57Z

It still reports a lot of warnings in my environment.

But the current PR has already fixed a lot of issues is really helpful.
I can merge it first if you want to fix it in other PRs in the future.

MaximSmolskiy · 2022-11-13T11:46:32Z

It still reports a lot of warnings in my environment.

But the current PR has already fixed a lot of issues is really helpful. I can merge it first you want to fix it in other PRs in the future.

Yes, in this PR I wanted to fix all warnings in rst files. Now there should be only 4 warnings with rst files:
WARNING: document isn't included in any toctree. I'm not sure if they need to be added, and if yes, that I can do it well (add them in index.rst in proper places with proper titles).

The the PR turned out to be not small (about hundred lines were changed).

In the future I will try to fix other errors/warnings in other PRs.

you-n-g · 2022-11-13T12:24:58Z

I think docs/developer/code_standard_and_dev_guide.rst should be included in the index.rst

Files in hidden (docs/hidden/client.rst, docs/hidden/online.rst and docs/hidden/tuner.rst) should be ignored.
Maybe exclude_patterns will be useful

you-n-g · 2022-11-13T13:24:33Z

I think docs/developer/code_standard_and_dev_guide.rst should be included in the index.rst

Files in hidden (docs/hidden/client.rst, docs/hidden/online.rst and docs/hidden/tuner.rst) should be ignored. Maybe exclude_patterns will be useful

Would you like to update it in this PR?
Otherwise I'll merge it first.

MaximSmolskiy · 2022-11-13T13:30:35Z

I think docs/developer/code_standard_and_dev_guide.rst should be included in the index.rst
Files in hidden (docs/hidden/client.rst, docs/hidden/online.rst and docs/hidden/tuner.rst) should be ignored. Maybe exclude_patterns will be useful

Would you like to update it in this PR? Otherwise I'll merge it first.

I will try to do it in this PR soon

MaximSmolskiy · 2022-11-13T13:47:05Z

@you-n-g Now there are no warnings left with rst files and updated toc looks as follows

you-n-g · 2022-11-13T14:00:56Z

It looks great.
Do you think it will be more reasonable to put it before REFERENCE: and after OTHER COMPONENTS/FEATURES/TOPICS:?
@MaximSmolskiy

you-n-g · 2022-11-13T14:04:16Z

docs/index.rst

   Data Retrieval <start/getdata.rst>
   Custom Model Integration <start/integration.rst>

+.. toctree::


Do you think it will be more reasonable to put it before REFERENCE: and after OTHER COMPONENTS/FEATURES/TOPICS:?

you-n-g · 2022-11-13T14:12:45Z

It looks great!
Thanks for your great efforts.
Welcome to becoming one of Qlib's contributors!

…rosoft#1349) * Fix docs/advanced/alpha.rst * Fix docs/reference/api.rst * Fix docs/component/strategy.rst * Fix docs/start/integration.rst * Fix docs/component/report.rst * Fix docs/component/data.rst * Fix docs/component/rl/framework.rst * Fix docs/introduction/quick.rst * Fix docs/advanced/task_management.rst * Fix CHANGES.rst * Fix docs/developer/code_standard_and_dev_guide.rst * Fix docs/hidden/client.rst * Fix docs/component/online.rst * Fix docs/start/getdata.rst * Add docs/hidden to exclude patterns * Add docs/developer/code_standard_and_dev_guide.rst to index.rst * Change docs/developer/code_standard_and_dev_guide.rst place in index.rst

MaximSmolskiy added 14 commits November 12, 2022 17:03

Fix docs/advanced/alpha.rst

9c900df

Fix docs/reference/api.rst

bfc65a6

Fix docs/component/strategy.rst

2675d30

Fix docs/start/integration.rst

1607efd

Fix docs/component/report.rst

d331416

Fix docs/component/data.rst

3675b08

Fix docs/component/rl/framework.rst

5885e79

Fix docs/introduction/quick.rst

becd219

Fix docs/advanced/task_management.rst

2d2bc0d

Fix CHANGES.rst

1974334

Fix docs/developer/code_standard_and_dev_guide.rst

9293804

Fix docs/hidden/client.rst

71bc2fa

Fix docs/component/online.rst

74dc392

Fix docs/start/getdata.rst

1143c92

you-n-g reviewed Nov 13, 2022

View reviewed changes

MaximSmolskiy added 2 commits November 13, 2022 16:38

Add docs/hidden to exclude patterns

1891663

Add docs/developer/code_standard_and_dev_guide.rst to index.rst

7f221a5

MaximSmolskiy force-pushed the fix-the-Errors/Warnings-when-building-Qlibs-documentation branch from 4a3f228 to 7f221a5 Compare November 13, 2022 14:01

you-n-g reviewed Nov 13, 2022

View reviewed changes

Change docs/developer/code_standard_and_dev_guide.rst place in index.rst

4683717

you-n-g merged commit 82afd6a into microsoft:main Nov 13, 2022

MaximSmolskiy deleted the fix-the-Errors/Warnings-when-building-Qlibs-documentation branch November 13, 2022 14:30

you-n-g added the documentation Improvements or additions to documentation label Dec 9, 2022

This was referenced Jun 23, 2025

Feature implementation from commits 3579484..7e5bab5 yashuatla/qlib#1

Open

Feature implementation from commits 67d618d..994f893 yashuatla/qlib#2

Open

This was referenced Jun 30, 2025

Feature implementation from commits 94e420f..0c4db8b codeOwlAI/qlib#2

Open

Feature implementation from commits 1861c8e..82afd6a codeOwlAI/qlib#3

Open


		This whole process can be used in `Online Serving <../component/online.html>`_.

		An example of the entire process is shown `here <https://github.com/microsoft/qlib/tree/main/examples/model_rolling/task_manager_rolling.py>`_.

Conversation

MaximSmolskiy commented Nov 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Screenshots of Test Results (if appropriate):

Types of changes

Uh oh!

MaximSmolskiy commented Nov 12, 2022

Uh oh!

you-n-g Nov 13, 2022

Choose a reason for hiding this comment

Uh oh!

MaximSmolskiy Nov 13, 2022

Choose a reason for hiding this comment

Uh oh!

you-n-g Nov 13, 2022

Choose a reason for hiding this comment

Uh oh!

you-n-g commented Nov 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MaximSmolskiy commented Nov 13, 2022

Uh oh!

you-n-g commented Nov 13, 2022

Uh oh!

you-n-g commented Nov 13, 2022

Uh oh!

MaximSmolskiy commented Nov 13, 2022

Uh oh!

MaximSmolskiy commented Nov 13, 2022

Uh oh!

you-n-g commented Nov 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

you-n-g Nov 13, 2022

Choose a reason for hiding this comment

Uh oh!

MaximSmolskiy Nov 13, 2022

Choose a reason for hiding this comment

Uh oh!

you-n-g commented Nov 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MaximSmolskiy commented Nov 12, 2022 •

edited

Loading

you-n-g commented Nov 13, 2022 •

edited

Loading

you-n-g commented Nov 13, 2022 •

edited

Loading