search

collective / sphinxcontrib-httpexample

Adds example directive for sphinx-contrib httpdomain
23 stars 20 forks source link

Add ability to highlight certain lines in the request/response #10

Open skyzyx opened 7 years ago

skyzyx commented 7 years ago

Similar to how Sphinx supports highlighting lines in codeblocks.

http://www.sphinx-doc.org/en/stable/markup/code.html#line-numbers

datakurre commented 7 years ago

We already use code blocks, so if that doesn't already work with the same options, it should be easy to add.

On 7. huhtikuuta 2017 klo 3.05 +0300, Ryan Parman notifications@github.com, wrote:

Similar to how Sphinx supports highlighting lines in codeblocks.

http://www.sphinx-doc.org/en/stable/markup/code.html#line-numbers

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub (https://github.com/collective/sphinxcontrib-httpexample/issues/10), or mute the thread (https://github.com/notifications/unsubscribe-auth/AAJyvyGY46DyvCo6ShqeXRRmEEpgHiqSks5rtX1hgaJpZM4M2T1W).

skyzyx commented 7 years ago

Specifically, I'm using the external approach. In this example, I'm trying to highlight line 12 in the request, but not in the response.

.. http:example:: curl wget
   :request: fixtures/post-publishes-request-01.txt
   :emphasize-lines: 12
   :response: fixtures/post-publishes-response-01.txt
   :linenos:

Is this only possible with inline code blocks?

datakurre commented 7 years ago

Thanks for the details. I believe that those options affect currently only the possible inline request example. Those are not passed for external request or response, but that could be fixed. The order of the options does not matter, so we need to add "request" and "response" prefixed variants of those options.

So, this is a good idea and should be implemented.

On 7. huhtikuuta 2017 klo 21.46 +0300, Ryan Parman notifications@github.com, wrote:

Specifically, I'm using the external approach. In this example, I'm trying to highlight line 12 in the request, but not in the response.

.. http:example:: curl wget :request: fixtures/post-publishes-request-01.txt :emphasize-lines: 12 :response: fixtures/post-publishes-response-01.txt :linenos:

— You are receiving this because you commented. Reply to this email directly, view it on GitHub (https://github.com/collective/sphinxcontrib-httpexample/issues/10#issuecomment-292620291), or mute the thread (https://github.com/notifications/unsubscribe-auth/AAJyv_tJ5M_BdTAXWf9sVJyxuw8_6CVMks5rtoRfgaJpZM4M2T1W).