diff options
| author | Florian Bruhin <me@the-compiler.org> | 2018-12-12 08:10:28 +0100 |
|---|---|---|
| committer | Florian Bruhin <me@the-compiler.org> | 2018-12-12 10:32:42 +0100 |
| commit | a0437a3e683fa81e271be88c907e25143d0e467c (patch) | |
| tree | bef5db890b354f817893d052b953a16bf6141a51 /doc/extapi | |
| parent | 61bfecc4abf367180ad3387ea6bd06318fe67767 (diff) | |
| download | qutebrowser-a0437a3e683fa81e271be88c907e25143d0e467c.tar.gz qutebrowser-a0437a3e683fa81e271be88c907e25143d0e467c.zip | |
Improve Sphinx docs
Diffstat (limited to 'doc/extapi')
| -rw-r--r-- | doc/extapi/api.rst | 48 | ||||
| -rw-r--r-- | doc/extapi/index.rst | 48 | ||||
| -rw-r--r-- | doc/extapi/tab.rst | 44 |
3 files changed, 94 insertions, 46 deletions
diff --git a/doc/extapi/api.rst b/doc/extapi/api.rst new file mode 100644 index 000000000..b63db57c3 --- /dev/null +++ b/doc/extapi/api.rst @@ -0,0 +1,48 @@ +API modules +=========== + +cmdutils module +--------------- + +.. automodule:: qutebrowser.api.cmdutils + :members: + :imported-members: + +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: + :imported-members: + +message module +-------------- + +.. automodule:: qutebrowser.api.message + :members: + :imported-members: diff --git a/doc/extapi/index.rst b/doc/extapi/index.rst index e176e3a0d..d181c2ccd 100644 --- a/doc/extapi/index.rst +++ b/doc/extapi/index.rst @@ -10,53 +10,9 @@ Welcome to qutebrowser extensions's documentation! :maxdepth: 2 :caption: Contents: -cmdutils module ---------------- + api + tab -.. 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 ================== diff --git a/doc/extapi/tab.rst b/doc/extapi/tab.rst new file mode 100644 index 000000000..57a14ac6e --- /dev/null +++ b/doc/extapi/tab.rst @@ -0,0 +1,44 @@ +Tab API +======= + +.. autoclass:: qutebrowser.browser.browsertab.AbstractTab() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractAction() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractPrinting() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractSearch() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractZoom() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractCaret() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractScroller() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractHistory() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractElements() + :members: + +.. autoclass:: qutebrowser.browser.browsertab.AbstractAudio() + :members: + +Web element API +=============== + +.. autoclass:: qutebrowser.browser.webelem.AbstractWebElement + :members: + +.. autoclass:: qutebrowser.browser.webelem.Error + :members: + +.. autoclass:: qutebrowser.browser.webelem.OrphanedError + :members: |