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

Merged
merged 1 commit into from
Oct 22, 2018

Conversation

tmonck
Copy link
Contributor

@tmonck 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 homeassistant added the small-pr PRs with less than 30 lines. label Oct 20, 2018
@homeassistant
Copy link
Contributor

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
Copy link
Contributor Author

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 Add readthedoc.yml file to specify the version of python to run during documentation building. Fix Issue #16364 dev-doc: Documentation empty Oct 20, 2018
@tmonck
Copy link
Contributor Author

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
Copy link
Member

fabaff commented Oct 21, 2018

CI should pass now.

@tmonck
Copy link
Contributor Author

tmonck commented Oct 21, 2018

Thanks @fabaff.

@balloob
Copy link
Member

balloob commented Oct 22, 2018

oooh thanks !

@balloob balloob merged commit fd9370d into home-assistant:dev Oct 22, 2018
@ghost ghost removed the in progress label Oct 22, 2018
This was referenced Oct 22, 2018
@balloob balloob mentioned this pull request Nov 9, 2018
@home-assistant home-assistant locked and limited conversation to collaborators Feb 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed Hacktoberfest small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dev-docs: Documentation is empty
5 participants