Skip to content

fix: Fix documentation build with extra dependencies #566

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

Merged
merged 1 commit into from
Jul 31, 2023

Conversation

jules-ch
Copy link
Contributor

@jules-ch jules-ch commented Mar 8, 2023

Closes #565

Proposed Changes

  • Upgrade Sphinx versions & sphinx_rtd_theme
  • Install optional dependencies for documentation build
  • Update .readthedocs.yml to V2 format
  • Update conf.py

Checklist

  • CHANGELOG.md updated
  • Rebased/mergeable
  • A test has been added if appropriate
  • pytest tests completes successfully
  • Commit messages are conventional
  • Sign CLA (if not already signed)

@jules-ch jules-ch changed the title Fix docs sphinx fix: Fix documentation build with extra dependencies Mar 8, 2023
@jules-ch jules-ch force-pushed the fix-docs-sphinx branch 3 times, most recently from d76aba3 to fd07c38 Compare March 8, 2023 21:28
@codecov-commenter
Copy link

codecov-commenter commented Mar 8, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.02 ⚠️

Comparison is base (a4c5746) 90.30% compared to head (fd07c38) 90.29%.

❗ Current head fd07c38 differs from pull request most recent head 0660d8b. Consider uploading reports for the commit 0660d8b to get more accurate results

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #566      +/-   ##
==========================================
- Coverage   90.30%   90.29%   -0.02%     
==========================================
  Files          39       39              
  Lines        3456     3452       -4     
==========================================
- Hits         3121     3117       -4     
  Misses        335      335              

see 5 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@bednar bednar left a comment

Choose a reason for hiding this comment

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

Hi @jules-ch,

thanks for your PR 👍.

Can you please rebase the sources with master branch? After that we are be able to merge this PR.

Thanks

@jules-ch
Copy link
Contributor Author

jules-ch commented Jul 5, 2023

Alright I'll rebase this.

@jules-ch jules-ch requested a review from bednar July 5, 2023 16:06
@jules-ch
Copy link
Contributor Author

jules-ch commented Jul 5, 2023

Rebased on master

- Upgrade Sphinx versions & sphinx_rtd_theme
- Install optional dependencies for documentation build
- Update .readthedocs.yml to V2 format
- Use `html_css_files` to inject custom css in `conf.py`
@bednar
Copy link
Contributor

bednar commented Jul 31, 2023

@jules-ch thanks again for your PR 👍

@bednar bednar merged commit c8a3501 into influxdata:master Jul 31, 2023
@bednar bednar added this to the 1.38.0 milestone Jul 31, 2023
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.

Docs missing documented classes
3 participants