Choose another documentation theme

[isaak654]

Originally posted by @SiNONiMiTY in #54 (comment)

Do you think we can rewrite the sandboxie documentation using the ReadTheDocs format?

Take a look at the documentation of Unbound, a recursive dns server that has a lot of options:
https://unbound.docs.nlnetlabs.nl/en/latest/

I think this documentation format is very readable. Given that sandboxie has a lot of options, we can document it in this format.

Requested theme

• https://github.com/readthedocs/sphinx_rtd_theme

Alternative themes to consider

• https://github.com/just-the-docs/just-the-docs
• https://github.com/mkdocs/mkdocs

Recommendations for contributors

• Avoid breaking existing pages and current links such as https://sandboxie-plus.github.io/sandboxie-docs/Content/ResourceAccess.html
• If the suggested themes are not of your liking, feel free to suggest a new one

This issue is not in my plans, but if someone wanted to attach a pull request, that would be cool.

[QZLin]

What about this? Sandboxie Documentation(moved to https://qzlin.github.io/sandboxie-docs)
Generated by mkdocs with readthedocs theme
(repo here: https://github.com/QZLin/sandboxie-docs/)

[isaak654]

Theme is very good looking, I would suggest some improvements if possible:

• search feature has no highlighting and is not a fixed element of the page (especially when you scroll the left column). For these reasons, it would be great if you could adopt the mkdocs search provided in this sample (repository: https://github.com/okrc/sandboxie-docs)
• it would be ideal to replace the link above the search bar with a transparent version of the Sandboxie logo, as long as it remains linkable (of course other Sandboxie logos would be fine too).
• Footer should contain a View source code link or similar wording to incentivate contributions in the base repository. Also, it should contain the following references:
  
  The last one in particular allows to edit the same displayed page without effort, which is a nice bonus.

[stdedos]

There is also a newer template of the https://sphinx-rtd-theme.readthedocs.io/en/stable/: https://pylint.readthedocs.io/en/stable/

What is the status of this one by the way? I'd be interested to learn how ReadTheDocs works - or contribute changes / borrow existing commits to build a result.

[stdedos]

The theme shown above is "Furo" (pytest-dev/pytest-cov#618)