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

feanil/rtd update #2017

Merged
merged 7 commits into from
Aug 8, 2023
Merged

feanil/rtd update #2017

merged 7 commits into from
Aug 8, 2023

Conversation

feanil
Copy link
Contributor

@feanil feanil commented Aug 7, 2023

  • docs: Add a ReadTheDocs Config.
  • docs: Add a requirements file to build the docs.
  • chore: Run make upgrade
  • docs: Add a basic sphinx build setup.
  • docs: Correct some docs warnings.

@feanil feanil requested a review from a team as a code owner August 7, 2023 18:16
@codecov
Copy link

codecov bot commented Aug 7, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (8145367) 95.08% compared to head (74c6421) 95.08%.
Report is 5 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2017   +/-   ##
=======================================
  Coverage   95.08%   95.08%           
=======================================
  Files         158      158           
  Lines       17429    17429           
  Branches     1626     1626           
=======================================
  Hits        16572    16572           
  Misses        642      642           
  Partials      215      215           
Flag Coverage Δ
unittests 95.08% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@UsamaSadiq UsamaSadiq left a comment

Choose a reason for hiding this comment

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

Merging the PR to resolve docs check failure on other PRs.

@UsamaSadiq
Copy link
Member

Running make upgrade with Python 3.8 somehow downgraded the Sphinx version which caused the docs build to fail. Investigating the reason for the downgrade since we are currently using Python 3.8 in the package.

@feanil feanil merged commit 0faef57 into master Aug 8, 2023
6 checks passed
@feanil feanil deleted the feanil/rtd_update branch August 8, 2023 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants