R2Northstar/ModdingDocs

Use sphinx-tabs for OS specific docs.

Closed this issue · 4 comments

laundmo commented

Investigate the usage of https://github.com/executablebooks/sphinx-tabs for switching between OS specific documentation

todo:

  • investigate theme compatibility
  • PR changes to conf.py and requirements needed

PRs which are potentially blocked by this: #73

cc: @GeckoEidechse

begin-theadventure commented

Hmm, blocked? I think more like #73 potentially needs this 😄 (and now #82 too).
Frankly, sphinx-tabs would be a cool feature to have.

laundmo commented

Hmm, blocked? I think more like #73 potentially needs this 😄 (and now #82 too).

That's what i meant, edited it to say so.

begin-theadventure commented

Is this only visible on the website?

laundmo commented

This should also be visible if you use the recommended poetry run build as described on the https://r2northstar.readthedocs.io/en/latest/guides/contributing.html page. if you use the VSCode preview it wont show up.