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

dev-docs: Documentation is empty #16364

Closed
klada opened this issue Sep 2, 2018 · 7 comments · Fixed by #17642
Closed

dev-docs: Documentation is empty #16364

klada opened this issue Sep 2, 2018 · 7 comments · Fixed by #17642

Comments

@klada
Copy link
Contributor

klada commented Sep 2, 2018

Component/platform: dev-docs

Description of problem:

The sphinx-build for the developer docs is broken ATM. The autoclass statements do not generate any documentation. See:

https://dev-docs.home-assistant.io/en/master/api/core.html

(empty content)

@fabaff
Copy link
Member

fabaff commented Sep 2, 2018

I was trying to track down the issue but didn't solve it. Thanks for bringing it up again.

@fabaff fabaff self-assigned this Sep 2, 2018
@fabaff fabaff mentioned this issue Sep 6, 2018
2 tasks
@fabaff fabaff removed their assignment Sep 30, 2018
@fredrikbaberg
Copy link
Contributor

Since building documentation locally seems to work, how could I try to help with this?
Who builds and publishes the documentation? Travis? A script somewhere?

@tmonck
Copy link
Contributor

tmonck commented Oct 20, 2018

@FrederikBolding it looks like they are being built at readthedocs. I could be wrong perhaps @fabaff could confirm or deny what I think. I'm also looking at this too if you want to work together @FrederikBolding

@tmonck
Copy link
Contributor

tmonck commented Oct 20, 2018

I am able to replicate by setting up my own read the docs build.

@tmonck
Copy link
Contributor

tmonck commented Oct 20, 2018

Looks like readthedocs is running python 3.5.2 which doesn't have Coroutine. Seems like it's available in 3.5.3. I'm trying to see if I can tell readthedocs which python version I want.

@tmonck
Copy link
Contributor

tmonck commented Oct 20, 2018

PR coming

@tmonck
Copy link
Contributor

tmonck commented Oct 20, 2018

As a note the yml file can't parse patch versions so I had to put the python version to 3.6.

@ghost ghost removed the in progress label Oct 22, 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
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants