From 133eb22836a42c17cb8b55cd36c4fe190c781db6 Mon Sep 17 00:00:00 2001 From: xuj2 <72422668+xuj2@users.noreply.github.com> Date: Wed, 8 Jun 2022 15:47:25 -0700 Subject: [PATCH] add table of contents to Flask, Blueprint, Request, and Response objects Adding table of contents specifically to Flask, Blueprint, Request, and Response objects to make it easier and quicker for users to navigate through long lists of class functions and properties. --- docs/api.rst | 287 +++++++++++++++++++++++++++++++++++++++++++++++++++ docs/conf.py | 1 + 2 files changed, 288 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index b3cffde2..2db094c8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -11,6 +11,113 @@ important right here and provide links to the canonical documentation. Application Object ------------------ +.. autosummary:: + Flask.add_template_filter + Flask.add_template_global + Flask.add_template_test + Flask.add_url_rule + Flask.after_request + Flask.app_context + Flask.app_ctx_globals_class + Flask.async_to_sync + Flask.auto_find_instance_path + Flask.before_first_request + Flask.before_first_request_funcs + Flask.before_request + Flask.config + Flask.blueprints + Flask.config_class + Flask.context_processor + Flask.create_global_jinja_loader + Flask.create_jinja_environment + Flask.create_url_adapter + Flask.debug + Flask.delete + Flask.dispatch_request + Flask.do_teardown_appcontext + Flask.do_teardown_request + Flask.endpoint + Flask.ensure_sync + Flask.env + Flask.errorhandler + Flask.extensions + Flask.full_dispatch_request + Flask.get + Flask.get_send_file_max_age + Flask.got_first_request + Flask.handle_exception + Flask.handle_http_exception + Flask.handle_url_build_error + Flask.handle_user_exception + Flask.has_static_folder + Flask.inject_url_defaults + Flask.instance_path + Flask.iter_blueprints + Flask.jinja_env + Flask.jinja_environment + Flask.jinja_loader + Flask.jinja_options + Flask.json_decoder + Flask.json_encoder + Flask.log_exception + Flask.logger + Flask.make_config + Flask.make_default_options_response + Flask.make_response + Flask.make_shell_context + Flask.name + Flask.open_instance_resource + Flask.open_resource + Flask.patch + Flask.permanent_session_lifetime + Flask.post + Flask.preprocess_request + Flask.preserve_context_on_exception + Flask.process_response + Flask.propagate_exceptions + Flask.put + Flask.register_blueprint + Flask.register_error_handler + Flask.request_class + Flask.request_context + Flask.response_class + Flask.route + Flask.run + Flask.secret_key + Flask.select_jinja_autoescape + Flask.send_file_max_age_default + Flask.send_static_file + Flask.session_cookie_name + Flask.session_interface + Flask.shell_context_processor + Flask.shell_context_processors + Flask.should_ignore_error + Flask.static_folder + Flask.static_url_path + Flask.teardown_appcontext + Flask.teardown_appcontext_funcs + Flask.teardown_request + Flask.template_filter + Flask.template_global + Flask.template_test + Flask.templates_auto_reload + Flask.test_cli_runner + Flask.test_cli_runner_class + Flask.test_client + Flask.test_client_class + Flask.test_request_context + Flask.testing + Flask.trap_http_exception + Flask.update_template_context + Flask.url_build_error_handlers + Flask.url_defaults + Flask.url_map + Flask.url_map_class + Flask.url_rule_class + Flask.url_value_preprocessor + Flask.use_x_sendfile + Flask.wsgi_app + .. autoclass:: Flask :members: :inherited-members: @@ -19,6 +126,52 @@ Application Object Blueprint Objects ----------------- +.. autosummary:: + Blueprint.add_app_template_filter + Blueprint.add_app_template_global + Blueprint.add_app_template_test + Blueprint.add_url_rule + Blueprint.after_app_request + Blueprint.after_request + Blueprint.app_context_processor + Blueprint.app_errorhandler + Blueprint.app_template_filter + Blueprint.app_template_global + Blueprint.app_template_test + Blueprint.app_url_defaults + Blueprint.app_url_value_preprocessor + Blueprint.before_app_first_request + Blueprint.before_app_request + Blueprint.before_request + Blueprint.context_processor + Blueprint.delete + Blueprint.endpoint + Blueprint.errorhandler + Blueprint.get + Blueprint.get_send_file_max_age + Blueprint.has_static_folder + Blueprint.jinja_loader + Blueprint.json_decoder + Blueprint.json_encoder + Blueprint.make_setup_state + Blueprint.open_resource + Blueprint.patch + Blueprint.post + Blueprint.put + Blueprint.record + Blueprint.record_once + Blueprint.register + Blueprint.register_blueprint + Blueprint.register_error_handler + Blueprint.route + Blueprint.send_static_file + Blueprint.static_folder + Blueprint.static_url_path + Blueprint.teardown_app_request + Blueprint.teardown_request + Blueprint.url_defaults + Blueprint.url_value_preprocessor + .. autoclass:: Blueprint :members: :inherited-members: @@ -26,6 +179,79 @@ Blueprint Objects Incoming Request Data --------------------- +.. autosummary:: + Request.accept_charsets + Request.accept_encodings + Request.accept_languages + Request.accept_mimetypes + Request.access_control_request_headers + Request.access_control_request_method + Request.access_route + Request.application + Request.args + Request.authorization + Request.base_url + Request.blueprint + Request.blueprints + Request.cache_control + Request.close + Request.content_encoding + Request.content_length + Request.content_md5 + Request.content_type + Request.cookies + Request.data + Request.date + Request.dict_storage_class + Request.endpoint + Request.files + Request.form + Request.form_data_parser_class + Request.from_values + Request.full_path + Request.get_data + Request.get_json + Request.host + Request.host_url + Request.if_match + Request.if_modified_since + Request.if_none_match + Request.if_range + Request.if_unmodified_since + Request.input_stream + Request.is_json + Request.is_multiprocess + Request.is_multithread + Request.is_run_once + Request.is_secure + Request.json + Request.list_storage_class + Request.make_form_data_parser + Request.max_content_length + Request.max_forwards + Request.mimetype + Request.mimetype_params + Request.on_json_loading_failed + Request.origin + Request.parameter_storage_class + Request.pragma + Request.range + Request.referrer + Request.remote_user + Request.root_url + Request.routing_exception + Request.script_root + Request.stream + Request.url + Request.url_charset + Request.url_root + Request.url_rule + Request.user_agent + Request.user_agent_class + Request.values + Request.view_args + Request.want_form_data_parsed + .. autoclass:: Request :members: :inherited-members: @@ -47,6 +273,67 @@ Incoming Request Data Response Objects ---------------- +.. autosummary:: + flask.Response.accept_ranges + flask.Response.access_control_allow_credentials + flask.Response.access_control_allow_headers + flask.Response.access_control_allow_methods + flask.Response.access_control_allow_origin + flask.Response.access_control_expose_headers + flask.Response.access_control_max_age + flask.Response.add_etag + flask.Response.age + flask.Response.allow + flask.Response.cache_control + flask.Response.calculate_content_length + flask.Response.call_on_close + flask.Response.close + flask.Response.content_encoding + flask.Response.content_language + flask.Response.content_length + flask.Response.content_location + flask.Response.content_md5 + flask.Response.content_range + flask.Response.content_security_policy + flask.Response.content_security_policy_report_only + flask.Response.content_type + flask.Response.cross_origin_embedder_policy + flask.Response.cross_origin_opener_policy + flask.Response.data + flask.Response.date + flask.Response.delete_cookie + flask.Response.expires + flask.Response.force_type + flask.Response.freeze + flask.Response.from_app + flask.Response.get_app_iter + flask.Response.get_data + flask.Response.get_etag + flask.Response.get_json + flask.Response.get_wsgi_headers + flask.Response.get_wsgi_response + flask.Response.is_json + flask.Response.is_sequence + flask.Response.is_streamed + flask.Response.iter_encoded + flask.Response.json + flask.Response.last_modified + flask.Response.location + flask.Response.make_conditional + flask.Response.make_sequence + flask.Response.max_cookie_size + flask.Response.mimetype + flask.Response.mimetype_params + flask.Response.retry_after + flask.Response.set_cookie + flask.Response.set_data + flask.Response.set_etag + flask.Response.status + flask.Response.status_code + flask.Response.stream + flask.Response.vary + flask.Response.www_authenticate + .. autoclass:: flask.Response :members: :inherited-members: diff --git a/docs/conf.py b/docs/conf.py index ae2922d7..2fedca8d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,7 @@ extensions = [ "pallets_sphinx_themes", "sphinx_issues", "sphinx_tabs.tabs", + "sphinx.ext.autosummary", ] autodoc_typehints = "description" intersphinx_mapping = {