diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 2 | ||||
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/dev/models.rst | 58 |
3 files changed, 50 insertions, 13 deletions
diff --git a/docs/Makefile b/docs/Makefile index a22bc8a2..99264d90 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -192,4 +192,4 @@ pseudoxml: @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." livehtml: - sphinx-autobuild -b html -z '../libmproxy' -r '___jb_(old|bak)___$$' $(ALLSPHINXOPTS) $(BUILDDIR)/html
\ No newline at end of file + sphinx-autobuild -b html -z '../libmproxy' -z '../../netlib/netlib' -r '___jb_(old|bak)___$$' $(ALLSPHINXOPTS) $(BUILDDIR)/html
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 1e686007..ff4a4a86 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,6 +40,9 @@ extensions = [ 'sphinxcontrib.documentedlist' ] +# https://github.com/sphinx-doc/sphinx/pull/2053 +napoleon_include_special_with_doc = False + autodoc_member_order = "bysource" # Add any paths that contain templates here, relative to this directory. diff --git a/docs/dev/models.rst b/docs/dev/models.rst index 9929e4b2..b09c8bae 100644 --- a/docs/dev/models.rst +++ b/docs/dev/models.rst @@ -3,23 +3,57 @@ Models ====== -.. warning:: - The documentation for models has not been converted to rst yet and **many attributes/features - are missing**. - Please read the source code instead. +.. automodule:: netlib.http -.. automodule:: libmproxy.models - :show-inheritance: - :members: - :undoc-members: + .. autoclass:: Request + .. rubric:: Data + .. autoattribute:: first_line_format + .. autoattribute:: method + .. autoattribute:: scheme + .. autoattribute:: host + .. autoattribute:: port + .. autoattribute:: path + .. autoattribute:: http_version + .. autoattribute:: headers + .. autoattribute:: content + .. autoattribute:: timestamp_start + .. autoattribute:: timestamp_end + .. rubric:: Computed Properties and Convenience Methods + .. autoattribute:: text + .. autoattribute:: url + .. autoattribute:: pretty_host + .. autoattribute:: pretty_url + .. autoattribute:: query + .. autoattribute:: cookies + .. autoattribute:: path_components + .. automethod:: anticache + .. automethod:: anticomp + .. automethod:: constrain_encoding + .. autoattribute:: urlencoded_form + .. autoattribute:: multipart_form -.. automodule:: netlib.http.semantics - :members: Request, Response - :undoc-members: + .. autoclass:: Response + + .. rubric:: Data + .. autoattribute:: http_version + .. autoattribute:: status_code + .. autoattribute:: reason + .. autoattribute:: headers + .. autoattribute:: content + .. autoattribute:: timestamp_start + .. autoattribute:: timestamp_end + .. rubric:: Computed Properties and Convenience Methods + .. autoattribute:: text + .. autoattribute:: cookies .. autoclass:: Headers - :show-inheritance: :members: :special-members: :no-undoc-members: + + .. autoclass:: decoded + +.. automodule:: libmproxy.models + :show-inheritance: + :members: HTTPFlow, Error, ClientConnection, ServerConnection
\ No newline at end of file |