Skip to content

Hide line support in @snip directive #157

Closed
@2m

Description

@2m

The old sphinx doc tool-chain in akka-http supported hiding arbitrary code lines from inclusion in the snippets by adding a // hide to the end of the line. This is now lacking in the current @snip directive. Instead current akka-http docs contain // hide comments in some of the pages, like this one.

There are 18 such comments in the akka-http docs currently.

docs/src/test/scala/docs/http/scaladsl/HttpServerExampleSpec.scala:                complete("") // hide
docs/src/test/scala/docs/http/scaladsl/server/CaseClassExtractionExamplesSpec.scala:          null // hide
docs/src/test/scala/docs/http/scaladsl/server/CaseClassExtractionExamplesSpec.scala:    Get("/color?red=1&green=2&blue=3") ~> route ~> check { responseAs[String] shouldEqual "Color(1,2,3)" } // hide
docs/src/test/scala/docs/http/scaladsl/server/CaseClassExtractionExamplesSpec.scala:          null // hide
docs/src/test/scala/docs/http/scaladsl/server/CaseClassExtractionExamplesSpec.scala:    Get("/color?red=1&green=2&blue=3") ~> route ~> check { responseAs[String] shouldEqual "Color(1,2,3)" } // hide
docs/src/test/scala/docs/http/scaladsl/server/CaseClassExtractionExamplesSpec.scala:          null // hide
docs/src/test/scala/docs/http/scaladsl/server/CaseClassExtractionExamplesSpec.scala:    Get("/color/abc?r=1&g=2&b=3") ~> route ~> check { responseAs[String] shouldEqual "Color(abc,1,2,3)" } // hide
docs/src/test/scala/docs/http/scaladsl/server/DirectiveExamplesSpec.scala:    verify(route) // hide
docs/src/test/scala/docs/http/scaladsl/server/DirectiveExamplesSpec.scala:    verify(route) // hide
docs/src/test/scala/docs/http/scaladsl/server/DirectiveExamplesSpec.scala:    verify(route) // hide
docs/src/test/scala/docs/http/scaladsl/server/DirectiveExamplesSpec.scala:    verify(route) // hide
docs/src/test/scala/docs/http/scaladsl/server/DirectiveExamplesSpec.scala:    verify(route) // hide
docs/src/test/scala/docs/http/scaladsl/server/DirectiveExamplesSpec.scala:    verify(route) // hide
docs/src/test/scala/docs/http/scaladsl/server/DirectiveExamplesSpec.scala:    verify(route) // hide
docs/src/test/scala/docs/http/scaladsl/server/DirectiveExamplesSpec.scala:    verify(route) // hide
docs/src/test/scala/docs/http/scaladsl/server/ExceptionHandlerExamplesSpec.scala:        null // hide
docs/src/test/scala/docs/http/scaladsl/server/ExceptionHandlerExamplesSpec.scala:      null // hide
docs/src/test/scala/docs/http/scaladsl/server/RejectionHandlerExamplesSpec.scala:      null // hide

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions