From 61bfecc4abf367180ad3387ea6bd06318fe67767 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Tue, 11 Dec 2018 19:20:46 +0100 Subject: [PATCH] Initial sphinx docs --- doc/extapi/conf.py | 3 ++- doc/extapi/index.rst | 46 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 1 deletion(-) diff --git a/doc/extapi/conf.py b/doc/extapi/conf.py index 986290a48..09105248a 100644 --- a/doc/extapi/conf.py +++ b/doc/extapi/conf.py @@ -40,6 +40,7 @@ release = '' # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon', ] # Add any paths that contain templates here, relative to this directory. @@ -174,4 +175,4 @@ epub_title = project epub_exclude_files = ['search.html'] -# -- Extension configuration ------------------------------------------------- \ No newline at end of file +# -- Extension configuration ------------------------------------------------- diff --git a/doc/extapi/index.rst b/doc/extapi/index.rst index 896c43891..e176e3a0d 100644 --- a/doc/extapi/index.rst +++ b/doc/extapi/index.rst @@ -10,7 +10,53 @@ Welcome to qutebrowser extensions's documentation! :maxdepth: 2 :caption: Contents: +cmdutils module +--------------- +.. automodule:: qutebrowser.api.cmdutils + :members: + +.. FIXME: What about imported things? + +apitypes module +--------------- + +.. automodule:: qutebrowser.api.apitypes + :members: + :imported-members: + +config module +------------- + +.. automodule:: qutebrowser.api.config + :members: + +downloads module +---------------- + +.. automodule:: qutebrowser.api.downloads + :members: + +hook module +----------- + +.. automodule:: qutebrowser.api.hook + :members: + +interceptor module +------------------ + +.. automodule:: qutebrowser.api.interceptor + :members: + +.. FIXME: What about imported things? + +message module +-------------- + +.. automodule:: qutebrowser.api.message + :members: + :imported-members: Indices and tables ==================