Skip to content

Commit

Permalink
Remove explicit method listing (#574)
Browse files Browse the repository at this point in the history
* Remove options filter

* Remove options and separate method listings from docs

* Update docs

* Move guides to appropriate place

* Generate docs for classes without docstrings

* Split middleware initiation line
  • Loading branch information
kumaranvpl authored Sep 8, 2023
1 parent bb0a885 commit f5a07e2
Show file tree
Hide file tree
Showing 338 changed files with 927 additions and 607 deletions.
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/app/ABCApp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.app.ABCApp
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/app/FastStream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.app.FastStream
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.base.AsyncAPIOperation
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.generate.get_app_broker_channels
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.generate.get_app_broker_server
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.generate.get_app_schema
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.message.get_model_schema
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.message.get_response_schema
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.message.parse_handler_params
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.amqp.ChannelBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.amqp.Exchange
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.amqp.OperationBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.amqp.Queue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.amqp.ServerBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.kafka.ChannelBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.kafka.OperationBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.kafka.ServerBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.main.ChannelBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.main.OperationBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.main.ServerBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.nats.ChannelBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.nats.OperationBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.nats.ServerBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.redis.ChannelBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.redis.OperationBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.redis.ServerBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.sqs.ChannelBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.sqs.OperationBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.bindings.sqs.ServerBinding
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.channels.Channel
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.info.Contact
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.info.ContactDict
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.info.EmailStr
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/asyncapi/schema/info/Info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.info.Info
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.info.License
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.info.LicenseDict
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.main.Components
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/asyncapi/schema/main/Schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.main.Schema
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.message.CorrelationId
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.message.Message
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.operations.Operation
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.security.OauthFlowObj
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.security.OauthFlows
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.security.SecuritySchemaComponent
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.servers.Server
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.servers.ServerVariable
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.utils.ExternalDocs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.utils.ExternalDocsDict
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.utils.Parameter
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.utils.Reference
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/asyncapi/schema/utils/Tag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.utils.Tag
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.schema.utils.TagDict
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.utils.resolve_payloads
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/asyncapi/utils/to_camelcase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.asyncapi.utils.to_camelcase
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.core.abc.BrokerUsecase
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.core.abc.extend_dependencies
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.core.asyncronous.BrokerAsyncUsecase
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.core.asyncronous.default_filter
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.core.mixins.LoggingMixin
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.fastapi.route.StreamMessage
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.fastapi.route.StreamRoute
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.fastapi.route.get_app
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.fastapi.router.StreamRouter
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/handler/AsyncHandler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.handler.AsyncHandler
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/handler/BaseHandler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.handler.BaseHandler
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@


::: faststream.broker.message.ABCStreamMessage
options:
filters: []

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.message.StreamMessage
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.message.SyncStreamMessage
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.middlewares.BaseMiddleware
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.middlewares.CriticalLogMiddleware
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.parsers.decode_message
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.parsers.encode_message
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.parsers.resolve_custom_func
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@


::: faststream.broker.publisher.BasePublisher
options:
filters: ["!^publish$", "!^schema$"]

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.push_back_watcher.BaseWatcher
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.push_back_watcher.CounterWatcher
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.push_back_watcher.EndlessWatcher
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.push_back_watcher.OneTryWatcher
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.push_back_watcher.WatcherContext
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/router/BrokerRoute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.router.BrokerRoute
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/router/BrokerRouter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.router.BrokerRouter
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/schemas/NameRequired.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.schemas.NameRequired
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/schemas/RawDecoced.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.schemas.RawDecoced
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/test/TestApp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.test.TestApp
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/test/call_handler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.test.call_handler
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.test.patch_broker_calls
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.types.AsyncPublisherProtocol
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.utils.change_logger_handlers
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/broker/utils/get_watcher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.utils.get_watcher
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.utils.set_message_context
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.wrapper.FakePublisher
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.broker.wrapper.HandlerCallWrapper
3 changes: 3 additions & 0 deletions .faststream_gen/api/faststream/cli/main/version_callback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.cli.main.version_callback
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.cli.supervisors.basereload.BaseReload
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.cli.supervisors.multiprocess.Multiprocess
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.cli.supervisors.utils.get_subprocess
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.cli.supervisors.utils.set_exit
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


::: faststream.cli.supervisors.utils.subprocess_started
Loading

0 comments on commit f5a07e2

Please sign in to comment.