search

collective / sphinxcontrib-httpexample

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

Visual consistency with sphinx_tabs #25

Closed AWhetter closed 3 weeks ago

AWhetter commented 6 years ago

sphinx_tabs allows you to use tabs in Sphinx documentation. This is a very specific use case but I am using both sphinx_tabs and httpexample together. At the moment they look different but could we add some visual consistency between the two? Possibly even going to far as to have httpexample use sphinx-tabs under the hood. Doing this would make overriding the theme of both easier because they would use the same html elements and classes.

datakurre commented 6 years ago

We cannot change the directives or output structure used, but I would not mind us depending directly on sphinx_tabs just to be able to use its javascripts and styles for tabbing.

Ashley Whetter notifications@github.com kirjoitti 21.6.2018 kello 3.54:

sphinx_tabs allows you to use tabs in Sphinx documentation. This is a very specific use case but I am using both sphinx_tabs and httpexample together. At the moment they look different but could we add some visual consistency between the two? Possibly even going to far as to have httpexample use sphinx-tabs under the hood. Doing this would make overriding the theme of both easier because they would use the same html elements and classes.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

AWhetter commented 6 years ago

Can you expand on what you mean by output structure? Do you mean that the html output from the directive would need to be that same as what it is now?

datakurre commented 6 years ago

Yes, we definitely cannot change the directive nor require changes in existing documentations.

For output this plugin has nothing special, but only reuses existing Docutils/Sphinx doctree components.

The current tabbing is just a few lines a jquery and styles. It should be easily replaceable with something that mutates dom to fit sphinx_tabs styles.

Ashley Whetter notifications@github.com kirjoitti 21.6.2018 kello 9.31:

Can you expand on what you mean by output structure? Do you mean that the html output from the directive would need to be that same as what it is now?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or mute the thread.