Geoffrey McRae
4a4f72ba38
[doc] update and restructure installation documentation
2024-03-08 18:22:07 +11:00
Jonathan Rubenstein
f6b2cec841
[doc] html_unescape: Create html.unescape extension
...
This new sphinx extension runs html.unescape
(from the Python Standard Library) on source files before they are
rendered, allowing escape sequences like ' ' for the no-break
space character.
I have also published this extension in my own name under a different
license (the same one Sphinx uses) for others to use:
https://github.com/JJRcop/sphinxcontrib-html_unescape
2023-11-02 06:21:51 +11:00
Quantum
b6f994b511
[doc] css: add custom style for <kbd> elements
...
This makes them look like actual keys.
2022-09-19 14:59:40 +10:00
Geoffrey McRae
b10d912ab6
[doc] update copyright year
2022-09-18 19:28:19 +10:00
Jonathan Rubenstein
9ff476bd09
[doc] Minor cleanup to release spelling check
...
Co-authored-by: Guanzhong Chen <quantum2048@gmail.com>
2021-12-27 09:23:31 +11:00
Jonathan Rubenstein
6ef3fea05e
[doc] Version no longer gets spellchecked
2021-12-27 09:23:31 +11:00
Jonathan Rubenstein
a8ddf72318
[doc] conf: Fix typo in release git-describe command
...
We got the gist of it, but in the end, didn't git it right.
2021-12-26 14:12:39 +11:00
Jonathan Rubenstein
5d9db8b2f5
[docs] all: Change nav background from transparent to explicit
2021-12-26 13:57:05 +11:00
Jonathan Rubenstein
936688ddac
[doc] all: Center content when there's room
2021-12-26 13:28:40 +11:00
Jonathan Rubenstein
ff6c46f7ca
[docs] all: Switch to sphinx-readthedocs-theme
...
From https://github.com/readthedocs/sphinx_rtd_theme
2021-12-26 12:46:23 +11:00
Quantum
4dccd725bf
[doc] automatically detect version
...
We prefer the VERSION file if available, otherwise falling back to
querying version directly from git.
2021-12-26 12:08:24 +11:00
Jonathan Rubenstein
bb5c7a222c
[doc] conf: Whitespace
2021-12-26 10:02:07 +11:00
Quantum
753b44e34f
[doc] support building with spell check
2021-09-04 13:30:51 +10:00
Jonathan Rubenstein
86c7cfe589
[doc] Rerganize content into install and build pages
2021-05-25 19:52:08 +10:00
Jonathan Rubenstein
d44b55440f
[doc] conf: Enable fixed sidebar
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
a89c7993f9
[doc] credits: Add credits
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
940269c220
[doc] conf: Remove text under logo
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
83f060b895
[doc] config: Add LG logo and favicon
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
9d910ec37e
[doc] conf: Correct spelling of "xyene"
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
186038fd2e
[doc] conf: Add master_doc to explicitly use index.rst
...
This is for compatibility with older sphinx versions
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
91e55b9d5f
[doc] Import from wiki
...
Imported Installation, FAQ, Troubleshooting, OBS, and Technical FAQ pages
from wiki. Edits done to content as this is no longer a wiki, but versioned
in-repo documentation
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
30d2035a3e
[doc] Initialize Sphinx in /doc
2021-05-25 16:57:52 +10:00
