developers.home-assistant icon indicating copy to clipboard operation
developers.home-assistant copied to clipboard

Published 20 hours ago • verified publisher icon home-assistant

Move API documentation

Open fabaff opened this issue 6 years ago • 3 comments

The source for API documentation is located in the main repo.

Suggestion to move it and make it available at developers.home-assistant.

fabaff avatar Jun 02 '18 08:06 fabaff

The api docs are built with sphinx autodoc extension based on the code source and docstrings. How would you move that?

MartinHjelmare avatar Jun 02 '18 09:06 MartinHjelmare

Yeah we can't change that. I'm not sure how one would merge those or how we should approach that.

balloob avatar Jun 02 '18 12:06 balloob

Not sure if I should add this comment here or in main repo, so I'll start here. Just a thought, would the use of Github Pages help (https://pages.github.com/)? From Sphinx documentation there seem to be an extension for Github pages (http://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html).

fredrikbaberg avatar Oct 05 '18 13:10 fredrikbaberg