diff --git a/.gitignore b/.gitignore index ff20c088eb2..8a4154e4769 100644 --- a/.gitignore +++ b/.gitignore @@ -111,9 +111,6 @@ virtualization/vagrant/config !.vscode/tasks.json .env -# Built docs -docs/build - # Windows Explorer desktop.ini /home-assistant.pyproj diff --git a/.prettierignore b/.prettierignore index aab23e23078..07637a380c5 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,7 +1,6 @@ *.md .strict-typing azure-*.yml -docs/source/_templates/* homeassistant/components/*/translations/*.json homeassistant/generated/* tests/components/lidarr/fixtures/initialize.js diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 1a91abd9a99..00000000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,14 +0,0 @@ -# .readthedocs.yml - -version: 2 - -build: - os: ubuntu-20.04 - tools: - python: "3.9" - -python: - install: - - method: setuptools - path: . - - requirements: requirements_docs.txt diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 69893c43847..00000000000 --- a/docs/Makefile +++ /dev/null @@ -1,230 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " livehtml to make standalone HTML files via sphinx-autobuild" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " epub3 to make an epub3" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - @echo " dummy to check syntax errors of document sources" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: livehtml -livehtml: - sphinx-autobuild -z ../homeassistant/ --port 0 -B -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Home-Assistant.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Home-Assistant.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Home-Assistant" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Home-Assistant" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: epub3 -epub3: - $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 - @echo - @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." - -.PHONY: dummy -dummy: - $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy - @echo - @echo "Build finished. Dummy builder generates no files." diff --git a/docs/build/.empty b/docs/build/.empty deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 7713f1cadb0..00000000000 --- a/docs/make.bat +++ /dev/null @@ -1,281 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source -set I18NSPHINXOPTS=%SPHINXOPTS% source -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. epub3 to make an epub3 - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - echo. coverage to run coverage check of the documentation if enabled - echo. dummy to check syntax errors of document sources - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -REM Check if sphinx-build is available and fallback to Python version if any -%SPHINXBUILD% 1>NUL 2>NUL -if errorlevel 9009 goto sphinx_python -goto sphinx_ok - -:sphinx_python - -set SPHINXBUILD=python -m sphinx.__init__ -%SPHINXBUILD% 2> nul -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -:sphinx_ok - - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Home-Assistant.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Home-Assistant.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "epub3" ( - %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3 - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub3 file is in %BUILDDIR%/epub3. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -if "%1" == "coverage" ( - %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage - if errorlevel 1 exit /b 1 - echo. - echo.Testing of coverage in the sources finished, look at the ^ -results in %BUILDDIR%/coverage/python.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%/xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. - goto end -) - -if "%1" == "dummy" ( - %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. Dummy builder generates no files. - goto end -) - -:end diff --git a/docs/screenshot-integrations.png b/docs/screenshot-integrations.png deleted file mode 100644 index f169e4486a6..00000000000 Binary files a/docs/screenshot-integrations.png and /dev/null differ diff --git a/docs/screenshots.png b/docs/screenshots.png deleted file mode 100644 index 1305cddbb9d..00000000000 Binary files a/docs/screenshots.png and /dev/null differ diff --git a/docs/source/_ext/edit_on_github.py b/docs/source/_ext/edit_on_github.py deleted file mode 100644 index ecaea5450c9..00000000000 --- a/docs/source/_ext/edit_on_github.py +++ /dev/null @@ -1,45 +0,0 @@ -"""Sphinx extension for ReadTheDocs-style "Edit on GitHub" links on the sidebar. - -Loosely based on https://github.com/astropy/astropy/pull/347 -""" - -import os -import warnings - -__licence__ = "BSD (3 clause)" - - -def get_github_url(app, view, path): - """Build the GitHub URL.""" - return ( - f"https://github.com/{app.config.edit_on_github_project}/" - f"{view}/{app.config.edit_on_github_branch}/" - f"{app.config.edit_on_github_src_path}{path}" - ) - - -def html_page_context(app, pagename, templatename, context, doctree): - """Build the HTML page.""" - if templatename != "page.html": - return - - if not app.config.edit_on_github_project: - warnings.warn("edit_on_github_project not specified") - return - if not doctree: - warnings.warn("doctree is None") - return - path = os.path.relpath(doctree.get("source"), app.builder.srcdir) - show_url = get_github_url(app, "blob", path) - edit_url = get_github_url(app, "edit", path) - - context["show_on_github_url"] = show_url - context["edit_on_github_url"] = edit_url - - -def setup(app): - """Set up the app.""" - app.add_config_value("edit_on_github_project", "", True) - app.add_config_value("edit_on_github_branch", "master", True) - app.add_config_value("edit_on_github_src_path", "", True) # 'eg' "docs/" - app.connect("html-page-context", html_page_context) diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico deleted file mode 100644 index 6d12158c18b..00000000000 Binary files a/docs/source/_static/favicon.ico and /dev/null differ diff --git a/docs/source/_static/logo-apple.png b/docs/source/_static/logo-apple.png deleted file mode 100644 index 03b5dd7780c..00000000000 Binary files a/docs/source/_static/logo-apple.png and /dev/null differ diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png deleted file mode 100644 index 3cd8005a166..00000000000 Binary files a/docs/source/_static/logo.png and /dev/null differ diff --git a/docs/source/_templates/links.html b/docs/source/_templates/links.html deleted file mode 100644 index 7982649f72e..00000000000 --- a/docs/source/_templates/links.html +++ /dev/null @@ -1,6 +0,0 @@ - diff --git a/docs/source/_templates/sourcelink.html b/docs/source/_templates/sourcelink.html deleted file mode 100644 index 8cf2c4f92ae..00000000000 --- a/docs/source/_templates/sourcelink.html +++ /dev/null @@ -1,13 +0,0 @@ -{%- if show_source and has_source and sourcename %} -

{{ _('This Page') }}

- -{%- endif %} diff --git a/docs/source/api/auth.rst b/docs/source/api/auth.rst deleted file mode 100644 index 16a1dc69b6b..00000000000 --- a/docs/source/api/auth.rst +++ /dev/null @@ -1,29 +0,0 @@ -:mod:`homeassistant.auth` -========================= - -.. automodule:: homeassistant.auth - :members: - -homeassistant.auth.auth\_store ------------------------------- - -.. automodule:: homeassistant.auth.auth_store - :members: - :undoc-members: - :show-inheritance: - -homeassistant.auth.const ------------------------- - -.. automodule:: homeassistant.auth.const - :members: - :undoc-members: - :show-inheritance: - -homeassistant.auth.models -------------------------- - -.. automodule:: homeassistant.auth.models - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/bootstrap.rst b/docs/source/api/bootstrap.rst deleted file mode 100644 index fdc0b1c731d..00000000000 --- a/docs/source/api/bootstrap.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _bootstrap_module: - -:mod:`homeassistant.bootstrap` ------------------------------- - -.. automodule:: homeassistant.bootstrap - :members: diff --git a/docs/source/api/components.rst b/docs/source/api/components.rst deleted file mode 100644 index a27f93765b4..00000000000 --- a/docs/source/api/components.rst +++ /dev/null @@ -1,170 +0,0 @@ -:mod:`homeassistant.components` -=============================== - -air\_quality --------------------------------------------- - -.. automodule:: homeassistant.components.air_quality - :members: - :undoc-members: - :show-inheritance: - -alarm\_control\_panel --------------------------------------------- - -.. automodule:: homeassistant.components.alarm_control_panel - :members: - :undoc-members: - :show-inheritance: - -binary\_sensor --------------------------------------------- - -.. automodule:: homeassistant.components.binary_sensor - :members: - :undoc-members: - :show-inheritance: - -camera ---------------------------- - -.. automodule:: homeassistant.components.camera - :members: - :undoc-members: - :show-inheritance: - -calendar ---------------------------- - -.. automodule:: homeassistant.components.calendar - :members: - :undoc-members: - :show-inheritance: - -climate ---------------------------- - -.. automodule:: homeassistant.components.climate - :members: - :undoc-members: - :show-inheritance: - -conversation ---------------------------- - -.. automodule:: homeassistant.components.conversation - :members: - :undoc-members: - :show-inheritance: - -cover ---------------------------- - -.. automodule:: homeassistant.components.cover - :members: - :undoc-members: - :show-inheritance: - -device\_tracker ---------------------------- - -.. automodule:: homeassistant.components.device_tracker - :members: - :undoc-members: - :show-inheritance: - -fan ---------------------------- - -.. automodule:: homeassistant.components.fan - :members: - :undoc-members: - :show-inheritance: - -light ---------------------------- - -.. automodule:: homeassistant.components.light - :members: - :undoc-members: - :show-inheritance: - -lock ---------------------------- - -.. automodule:: homeassistant.components.lock - :members: - :undoc-members: - :show-inheritance: - -media\_player ---------------------------- - -.. automodule:: homeassistant.components.media_player - :members: - :undoc-members: - :show-inheritance: - -notify ---------------------------- - -.. automodule:: homeassistant.components.notify - :members: - :undoc-members: - :show-inheritance: - -remote ---------------------------- - -.. automodule:: homeassistant.components.remote - :members: - :undoc-members: - :show-inheritance: - -switch ---------------------------- - -.. automodule:: homeassistant.components.switch - :members: - :undoc-members: - :show-inheritance: - -sensor -------------------------------------- - -.. automodule:: homeassistant.components.sensor - :members: - :undoc-members: - :show-inheritance: - -vacuum -------------------------------------- - -.. automodule:: homeassistant.components.vacuum - :members: - :undoc-members: - :show-inheritance: - -water\_heater -------------------------------------- - -.. automodule:: homeassistant.components.water_heater - :members: - :undoc-members: - :show-inheritance: - -weather ---------------------------- - -.. automodule:: homeassistant.components.weather - :members: - :undoc-members: - :show-inheritance: - -webhook ---------------------------- - -.. automodule:: homeassistant.components.webhook - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/config_entries.rst b/docs/source/api/config_entries.rst deleted file mode 100644 index 4a207b82e16..00000000000 --- a/docs/source/api/config_entries.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _config_entries_module: - -:mod:`homeassistant.config_entries` ------------------------------------ - -.. automodule:: homeassistant.config_entries - :members: diff --git a/docs/source/api/core.rst b/docs/source/api/core.rst deleted file mode 100644 index 7928655b8a1..00000000000 --- a/docs/source/api/core.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _core_module: - -:mod:`homeassistant.core` -------------------------- - -.. automodule:: homeassistant.core - :members: \ No newline at end of file diff --git a/docs/source/api/data_entry_flow.rst b/docs/source/api/data_entry_flow.rst deleted file mode 100644 index 0159dd51c5a..00000000000 --- a/docs/source/api/data_entry_flow.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _data_entry_flow_module: - -:mod:`homeassistant.data_entry_flow` ------------------------------------- - -.. automodule:: homeassistant.data_entry_flow - :members: diff --git a/docs/source/api/exceptions.rst b/docs/source/api/exceptions.rst deleted file mode 100644 index e2977c51dae..00000000000 --- a/docs/source/api/exceptions.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _exceptions_module: - -:mod:`homeassistant.exceptions` -------------------------------- - -.. automodule:: homeassistant.exceptions - :members: diff --git a/docs/source/api/helpers.rst b/docs/source/api/helpers.rst deleted file mode 100644 index 753771ebc83..00000000000 --- a/docs/source/api/helpers.rst +++ /dev/null @@ -1,327 +0,0 @@ -:mod:`homeassistant.helpers` -============================ - -.. automodule:: homeassistant.helpers - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.aiohttp\_client -------------------------------------- - -.. automodule:: homeassistant.helpers.aiohttp_client - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.area\_registry ------------------------------------- - -.. automodule:: homeassistant.helpers.area_registry - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.check\_config ------------------------------------ - -.. automodule:: homeassistant.helpers.check_config - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.collection --------------------------------- - -.. automodule:: homeassistant.helpers.collection - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.condition -------------------------------- - -.. automodule:: homeassistant.helpers.condition - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.config\_entry\_flow ------------------------------------------ - -.. automodule:: homeassistant.helpers.config_entry_flow - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.config\_entry\_oauth2\_flow -------------------------------------------------- - -.. automodule:: homeassistant.helpers.config_entry_oauth2_flow - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.config\_validation ----------------------------------------- - -.. automodule:: homeassistant.helpers.config_validation - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.data\_entry\_flow ---------------------------------------- - -.. automodule:: homeassistant.helpers.data_entry_flow - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.debounce ------------------------------- - -.. automodule:: homeassistant.helpers.debounce - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.deprecation ---------------------------------- - -.. automodule:: homeassistant.helpers.deprecation - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.device\_registry --------------------------------------- - -.. automodule:: homeassistant.helpers.device_registry - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.discovery -------------------------------- - -.. automodule:: homeassistant.helpers.discovery - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.dispatcher --------------------------------- - -.. automodule:: homeassistant.helpers.dispatcher - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.entity ----------------------------- - -.. automodule:: homeassistant.helpers.entity - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.entity\_component ---------------------------------------- - -.. automodule:: homeassistant.helpers.entity_component - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.entity\_platform --------------------------------------- - -.. automodule:: homeassistant.helpers.entity_platform - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.entity\_registry --------------------------------------- - -.. automodule:: homeassistant.helpers.entity_registry - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.entity\_values ------------------------------------- - -.. automodule:: homeassistant.helpers.entity_values - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.entityfilter ----------------------------------- - -.. automodule:: homeassistant.helpers.entityfilter - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.event ---------------------------- - -.. automodule:: homeassistant.helpers.event - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.icon --------------------------- - -.. automodule:: homeassistant.helpers.icon - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.integration\_platform -------------------------------------------- - -.. automodule:: homeassistant.helpers.integration_platform - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.intent ----------------------------- - -.. automodule:: homeassistant.helpers.intent - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.json --------------------------- - -.. automodule:: homeassistant.helpers.json - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.location ------------------------------- - -.. automodule:: homeassistant.helpers.location - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.network ------------------------------ - -.. automodule:: homeassistant.helpers.network - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.restore\_state ------------------------------------- - -.. automodule:: homeassistant.helpers.restore_state - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.script ----------------------------- - -.. automodule:: homeassistant.helpers.script - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.service ------------------------------ - -.. automodule:: homeassistant.helpers.service - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.signal ------------------------------ - -.. automodule:: homeassistant.helpers.signal - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.state ---------------------------- - -.. automodule:: homeassistant.helpers.state - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.storage ------------------------------ - -.. automodule:: homeassistant.helpers.storage - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.sun -------------------------- - -.. automodule:: homeassistant.helpers.sun - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.system\_info ----------------------------------- - -.. automodule:: homeassistant.helpers.system_info - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.temperature ---------------------------------- - -.. automodule:: homeassistant.helpers.temperature - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.template ------------------------------- - -.. automodule:: homeassistant.helpers.template - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.translation ---------------------------------- - -.. automodule:: homeassistant.helpers.translation - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.typing ----------------------------- - -.. automodule:: homeassistant.helpers.typing - :members: - :undoc-members: - :show-inheritance: - -homeassistant.helpers.update\_coordinator ------------------------------------------ - -.. automodule:: homeassistant.helpers.update_coordinator - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/loader.rst b/docs/source/api/loader.rst deleted file mode 100644 index 91594a8a774..00000000000 --- a/docs/source/api/loader.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _loader_module: - -:mod:`homeassistant.loader` ---------------------------- - -.. automodule:: homeassistant.loader - :members: diff --git a/docs/source/api/util.rst b/docs/source/api/util.rst deleted file mode 100644 index 1ed4049c218..00000000000 --- a/docs/source/api/util.rst +++ /dev/null @@ -1,119 +0,0 @@ -:mod:`homeassistant.util` -========================= - -.. automodule:: homeassistant.util - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.yaml ------------------------ - -.. automodule:: homeassistant.util.yaml - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.aiohttp --------------------------- - -.. automodule:: homeassistant.util.aiohttp - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.async\_ --------------------------- - -.. automodule:: homeassistant.util.async_ - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.color ------------------------- - -.. automodule:: homeassistant.util.color - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.decorator ----------------------------- - -.. automodule:: homeassistant.util.decorator - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.dt ---------------------- - -.. automodule:: homeassistant.util.dt - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.json ------------------------ - -.. automodule:: homeassistant.util.json - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.location ---------------------------- - -.. automodule:: homeassistant.util.location - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.logging --------------------------- - -.. automodule:: homeassistant.util.logging - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.network --------------------------- - -.. automodule:: homeassistant.util.network - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.package --------------------------- - -.. automodule:: homeassistant.util.package - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.pil ----------------------- - -.. automodule:: homeassistant.util.pil - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.ssl ----------------------- - -.. automodule:: homeassistant.util.ssl - :members: - :undoc-members: - :show-inheritance: - -homeassistant.util.unit\_system -------------------------------- - -.. automodule:: homeassistant.util.unit_system - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index 3bd3baa39cc..00000000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,438 +0,0 @@ -#!/usr/bin/env python3 -"""Home Assistant documentation build configuration file. - -This file is execfile()d with the current directory set to its -containing dir. - -Note that not all possible configuration values are present in this -autogenerated file. - -All configuration values have a default; values that are commented out -serve to show the default. - -If extensions (or modules to document with autodoc) are in another directory, -add these directories to sys.path here. If the directory is relative to the -documentation root, use os.path.abspath to make it absolute, like shown here. -""" - -import inspect -import os -import sys - -from homeassistant.const import __short_version__, __version__ - -PROJECT_NAME = "Home Assistant" -PROJECT_PACKAGE_NAME = "homeassistant" -PROJECT_AUTHOR = "The Home Assistant Authors" -PROJECT_COPYRIGHT = PROJECT_AUTHOR -PROJECT_LONG_DESCRIPTION = ( - "Home Assistant is an open-source " - "home automation platform running on Python 3. " - "Track and control all devices at home and " - "automate control. " - "Installation in less than a minute." -) -PROJECT_GITHUB_USERNAME = "home-assistant" -PROJECT_GITHUB_REPOSITORY = "home-assistant" - -GITHUB_PATH = f"{PROJECT_GITHUB_USERNAME}/{PROJECT_GITHUB_REPOSITORY}" -GITHUB_URL = f"https://github.com/{GITHUB_PATH}" - - -sys.path.insert(0, os.path.abspath("_ext")) -sys.path.insert(0, os.path.abspath("../homeassistant")) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.linkcode", - "sphinx_autodoc_annotation", - "edit_on_github", -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = ".rst" - -# The encoding of source files. -# -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" - -# General information about the project. -project = PROJECT_NAME -copyright = PROJECT_COPYRIGHT -author = PROJECT_AUTHOR - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = __short_version__ -# The full version, including alpha/beta/rc tags. -release = __version__ - -code_branch = "dev" if "dev" in __version__ else "master" - -# Edit on Github config -edit_on_github_project = GITHUB_PATH -edit_on_github_branch = code_branch -edit_on_github_src_path = "docs/source/" - - -def linkcode_resolve(domain, info): - """Determine the URL corresponding to Python object.""" - if domain != "py": - return None - modname = info["module"] - fullname = info["fullname"] - submod = sys.modules.get(modname) - if submod is None: - return None - obj = submod - for part in fullname.split("."): - try: - obj = getattr(obj, part) - except Exception: # pylint: disable=broad-except - return None - try: - fn = inspect.getsourcefile(obj) - except Exception: # pylint: disable=broad-except - fn = None - if not fn: - return None - try: - source, lineno = inspect.findsource(obj) - except Exception: # pylint: disable=broad-except - lineno = None - if lineno: - linespec = "#L%d" % (lineno + 1) - else: - linespec = "" - index = fn.find("/homeassistant/") - if index == -1: - index = 0 - - fn = fn[index:] - - return f"{GITHUB_URL}/blob/{code_branch}/{fn}{linespec}" - - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = "en" - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# -# today = '' -# -# Else, today_fmt is used as the format for a strftime call. -# -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -html_theme_options = { - "logo": "logo.png", - "logo_name": PROJECT_NAME, - "description": PROJECT_LONG_DESCRIPTION, - "github_user": PROJECT_GITHUB_USERNAME, - "github_repo": PROJECT_GITHUB_REPOSITORY, - "github_type": "star", - "github_banner": True, - "touch_icon": "logo-apple.png", - # 'fixed_sidebar': True, # Re-enable when we have more content -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. -# " v documentation" by default. -# -# html_title = 'Home-Assistant v0.27.0' - -# A shorter title for the navigation bar. Default is the same as html_title. -# -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# -# html_logo = '_static/logo.png' - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. -# This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# -html_favicon = "_static/favicon.ico" - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# -# html_extra_path = [] - -# If not None, a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# The empty string is equivalent to '%b %d, %Y'. -# -html_last_updated_fmt = "%b %d, %Y" - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# -html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# -html_sidebars = { - "**": [ - "about.html", - "links.html", - "searchbox.html", - "sourcelink.html", - "navigation.html", - "relations.html", - ] -} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# -# html_additional_pages = {} - -# If false, no module index is generated. -# -# html_domain_indices = True - -# If false, no index is generated. -# -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' -# -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# 'ja' uses this config value. -# 'zh' user can custom change `jieba` dictionary path. -# -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "Home-Assistantdoc" - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - master_doc, - "home-assistant.tex", - "Home Assistant Documentation", - "Home Assistant Team", - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# -# latex_use_parts = False - -# If true, show page references after internal links. -# -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# -# latex_appendices = [] - -# It false, will not define \strong, \code, itleref, \crossref ... but only -# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added -# packages. -# -# latex_keep_old_macro_names = True - -# If false, no module index is generated. -# -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, "home-assistant", "Home Assistant Documentation", [author], 1) -] - -# If true, show URL addresses after external links. -# -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "Home-Assistant", - "Home Assistant Documentation", - author, - "Home Assistant", - "Open-source home automation platform.", - "Miscellaneous", - ) -] - -# Documents to append as an appendix to all manuals. -# -# texinfo_appendices = [] - -# If false, no module index is generated. -# -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# -# texinfo_no_detailmenu = False diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index c592f66c070..00000000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -================================ -Home Assistant API Documentation -================================ - -Public API documentation for `Home Assistant developers`_. - -Contents: - -.. toctree:: - :maxdepth: 2 - :glob: - - api/* - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -.. _Home Assistant developers: https://developers.home-assistant.io/ diff --git a/requirements_docs.txt b/requirements_docs.txt deleted file mode 100644 index ef700013d1d..00000000000 --- a/requirements_docs.txt +++ /dev/null @@ -1,3 +0,0 @@ -Sphinx==7.2.6 -sphinx-autodoc-typehints==1.10.3 -sphinx-autodoc-annotation==1.0.post1 \ No newline at end of file