General docs improvements for v3.0 (#2280)

* Split the docs into sections

* Split the options page into two pages - so the reference is more clean

* Reorder/Tidy up this 'deliver' page to make auto-deploy more obvious

* Fix up some links

* Merge the platform docs into a single page to clean up the navbar.

* Split the setup page to make a page dedicated to CI setup

* Move general platform-specific information into the platforms page

* Tidy up the platforms page

* Remove some redundancy in the cpp/platforms docs

* Clarify this section

* Move another FAQ entry to the platforms page

* Remove some out-of-date entries from the FAQ

* A few corrections to the options page

* Fix some broken links

* Improve the Docker references

* Update bump version filename

* Improve options TOC information density

* whitespace

Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>

* Convert the normal test invocation to `pytest ./tests`, not placeholder

---------

Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com>
This commit is contained in:
Joe Rickerby
2025-04-13 08:16:55 +02:00
committed by GitHub
co-authored by Henry Schreiner
parent 74a7d8a68e
commit 1d34f85c63
21 changed files with 817 additions and 855 deletions
+4 -53
View File
@@ -269,62 +269,13 @@ h1, h2, h3, h4, h5, h6 {
}
/* expand all the toctree entries */
.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,
.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,
.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,
.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,
.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,
.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,
.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,
.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,
.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,
.wy-menu-vertical .toctree-l10.current .toctree-l11>ul {
display: block;
}
/* hide all the buttons */
.wy-menu-vertical li.current>a button.toctree-expand,
.wy-menu-vertical li.on a button.toctree-expand,
.wy-menu-vertical li.toctree-l2 button.toctree-expand,
.wy-menu-vertical li a button.toctree-expand {
/* hide the l1 buttons */
.wy-menu-vertical li.toctree-l1.current>a button.toctree-expand,
.wy-menu-vertical li.toctree-l1.on>a button.toctree-expand,
.wy-menu-vertical li.toctree-l1>a button.toctree-expand {
display: none;
}
/* toctree layout improvements */
.wy-menu-vertical a {
padding: 0.4em 1.2em;
}
.wy-menu-vertical li.current>a,
.wy-menu-vertical li.on a {
font-weight: normal;
padding: 0.4em 1.2em;
/* border-right: 1px solid #f0f0f0; */
}
.wy-menu-vertical li.current a {
padding: 0.4em 1.2em;
}
.wy-menu-vertical li.toctree-l3 a,
.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a {
padding-left: 1.8em;
}
.wy-menu-vertical li.toctree-l2.current>a {
padding: 0.4em 1.2em;
}
.wy-menu-vertical li.toctree-l2.current>a,
.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a {
background: transparent;
}
.wy-menu-vertical li.toctree-l2.current>a:hover,
.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a:hover {
background: #d6d6d6;
}
.wy-menu-vertical li.current>a.current {
background: #fafafa !important;
}
.wy-menu-vertical li.current a {
}
/* word wrap in table cells */
.wy-table-responsive table td, .wy-table-responsive table th {