Initial sphinx docs

This commit is contained in:
Florian Bruhin 2018-12-11 19:20:46 +01:00
parent 24d45bfcba
commit 61bfecc4ab
2 changed files with 48 additions and 1 deletions

View File

@ -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 -------------------------------------------------
# -- Extension configuration -------------------------------------------------

View File

@ -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
==================