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

Update the docs/conf.py file to fix the docs build #1830

Merged
merged 3 commits into from Sep 15, 2021

Conversation

ajitdsa
Copy link
Contributor

@ajitdsa ajitdsa commented Sep 15, 2021

Description

The docs build is broken in opsdroid workflows.
See here: https://readthedocs.org/projects/opsdroid/builds/14715423/

I used the following to fix the issue:
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_mock_imports

Status

READY

Type of change

  • Documentation (fix or adds documentation)

How Has This Been Tested?

This has been tested in the ci and succeeds now:
https://readthedocs.org/projects/opsdroid/builds/14716702/

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@codecov
Copy link

codecov bot commented Sep 15, 2021

Codecov Report

Merging #1830 (1de4c28) into master (e806de3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1830   +/-   ##
=======================================
  Coverage   99.33%   99.33%           
=======================================
  Files          80       80           
  Lines        4817     4817           
=======================================
  Hits         4785     4785           
  Misses         32       32           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e806de3...1de4c28. Read the comment docs.

Copy link
Member

@jacobtomlinson jacobtomlinson left a comment

Choose a reason for hiding this comment

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

Awesome!

@jacobtomlinson jacobtomlinson merged commit 4628a73 into opsdroid:master Sep 15, 2021
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.

None yet

2 participants