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 Errors/Warnings when building Qlib's documentation #1381

Conversation

MaximSmolskiy
Copy link
Contributor

Description

Fix all the Errors/Warnings when building Qlib's documentation

Motivation and Context

Fix #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

@MaximSmolskiy
Copy link
Contributor Author

@you-n-g please check that this pr fixes all warnings in your environment and finally fixes the issue

Copy link
Collaborator

@you-n-g you-n-g left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks great!
All warnings have disappeared.

I think it would be better if we can check the doc compiling in the CI to protect current fruits.

@MaximSmolskiy
Copy link
Contributor Author

It looks great! All warnings have disappeared.

I think it would be better if we can check the doc compiling in the CI to protect current fruits.

@you-n-g Added doc compiling checking to CI and tested that it works

@you-n-g you-n-g merged commit 5b73b80 into microsoft:main Dec 5, 2022
@you-n-g
Copy link
Collaborator

you-n-g commented Dec 5, 2022

Thank you for making the docs great.

@MaximSmolskiy MaximSmolskiy deleted the fix-the-Errors/Warnings-when-building-Qlibs-documentation branch December 5, 2022 05:02
@you-n-g you-n-g added bug Something isn't working documentation Improvements or additions to documentation labels Dec 9, 2022
qianyun210603 pushed a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
…#1381)

* Fix the Errors/Warnings when building Qlib's documentation

* Fix

* Fix

* Empty

* Test CI

* Add doc compiling checking to CI

* Fix

* Tries to be consistent with Makefile

Co-authored-by: you-n-g <you-n-g@users.noreply.github.com>
qianyun210603 pushed a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
…#1381)

* Fix the Errors/Warnings when building Qlib's documentation

* Fix

* Fix

* Empty

* Test CI

* Add doc compiling checking to CI

* Fix

* Tries to be consistent with Makefile

Co-authored-by: you-n-g <you-n-g@users.noreply.github.com>
qianyun210603 pushed a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
…#1381)

* Fix the Errors/Warnings when building Qlib's documentation

* Fix

* Fix

* Empty

* Test CI

* Add doc compiling checking to CI

* Fix

* Tries to be consistent with Makefile

Co-authored-by: you-n-g <you-n-g@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix the Errors/Warnings when building Qlib's documentation.
2 participants