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 Issue #16364 dev-doc: Documentation empty #17642

Merged
merged 1 commit into from Oct 22, 2018

Conversation

Projects
None yet
5 participants
@tmonck
Contributor

tmonck commented Oct 20, 2018

Description:

Add readthedoc.yml file to specify the version of python to run during documentation building.

Read the docs was building documentation in Python 3.5.2 which was causing:
WARNING: autodoc: failed to import module 'homeassistant.bootstrap'; the following exception was raised:
cannot import name 'Coroutine'

Read the docs allows you to specify the required version of python by using a yaml file. https://docs.readthedocs.io/en/latest/yaml-config.html

Related issue (if applicable): fixes #16364

Pull request in home-assistant.io with documentation (if applicable): home-assistant/home-assistant.io#<home-assistant.io PR number goes here>

Example entry for configuration.yaml (if applicable):

Checklist:

  • The code change is tested and works locally.
  • Local tests pass with tox. Your PR cannot be merged unless tests pass

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

If the code does not interact with devices:.

@homeassistant

This comment has been minimized.

homeassistant commented Oct 20, 2018

Hi @tmonck,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@tmonck

This comment has been minimized.

Contributor

tmonck commented Oct 20, 2018

Not sure why the pylint portion of travis-ci build failed. Any guidance on fixing that would be appreciated.

@tmonck tmonck changed the title from Add readthedoc.yml file to specify the version of python to run during documentation building. to Fix Issue #16364 dev-doc: Documentation empty Oct 20, 2018

@tmonck

This comment has been minimized.

Contributor

tmonck commented Oct 21, 2018

https://home-assistant-doc-test.readthedocs.io/en/latest/api/bootstrap.html is it working in my personal readthedocs. I only used this for testing and plan on removing once this PR merges.

@fabaff

This comment has been minimized.

Member

fabaff commented Oct 21, 2018

CI should pass now.

@tmonck

This comment has been minimized.

Contributor

tmonck commented Oct 21, 2018

Thanks @fabaff.

@balloob

This comment has been minimized.

Member

balloob commented Oct 22, 2018

oooh thanks !

@balloob balloob merged commit fd9370d into home-assistant:dev Oct 22, 2018

5 checks passed

Hound No violations found. Woof!
WIP ready for review
Details
cla-bot All contributors have signed the CLA
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 93.605%
Details

@wafflebot wafflebot bot removed the in progress label Oct 22, 2018

This was referenced Oct 22, 2018

@balloob balloob referenced this pull request Nov 9, 2018

Merged

0.82 #18335

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment