Commit Graph

9 Commits

Author SHA1 Message Date
Mike Edmunds
e758579230 Docs: fix list spacing
Workaround sphinx-rtd-theme regression
on spacing in "open" lists.
2024-03-06 16:10:37 -08:00
Mike Edmunds
a2c0ed6817 Docs: fix broken links in search results
Upgrade to sphinx-rtd-theme 2.0.x
to fix broken links in search results
(for searches rendered client side).

See https://github.com/sphinx-doc/sphinx/issues/11608#issuecomment-1684410476
and https://github.com/readthedocs/sphinx_rtd_theme/pull/1507
2024-02-29 15:09:06 -08:00
medmunds
b4e22c63b3 Reformat code with automated tools
Apply standardized code style
2023-02-06 15:05:24 -08:00
medmunds
6c8a779ce1 Docs: add inline search form on help page
Referring to "the search docs box on the left"
doesn't make sense on mobile (which hides search
in the hamburger menu). Instead, just include
a search form at that point in the (html) docs.
2021-01-26 13:55:17 -08:00
Mike Edmunds
cca653fcba Docs: update tooling and outdated/broken content
* Update docs build config
  * Specify Sphinx and theme versions in docs/requirements.txt
    (tox had been using latest; RTD had pinned older versions)
  * Update docs builds for Python 3 and recent Sphinx
  * Remove obsolete sphinx-rtd-theme patches
  * Add .readthedocs.yml
  * Move some JS to async (now that Sphinx supports that)
  * Fix version-alert.js for async loading
* Remove docs versionadded/changed info older than v3.0
* Fix broken GitHub issue links in changelog (never worked?)
* Add setup long_description_content_type
* Drop poorly maintained AUTHORS.txt 
  (just point to GitHub contributors page)
2020-09-07 12:05:39 -07:00
medmunds
bd55d8c298 Rework editorconfig
* Most file types prefer 2-space indents, so now default
  to that and list the exceptions
* Add max_line_length=120 for .py files (Django convention)
* Bat files require CRLF
2019-02-08 12:05:57 -08:00
medmunds
7b58d87079 Docs: Show code cross-reference links as clickable (blue) 2019-02-05 11:34:51 -08:00
medmunds
64bb3b6098 Docs: freeze left column of ESP feature matrix
(Make the wide table a little more readable.)
2018-04-05 18:03:59 -07:00
medmunds
0c3e3e9bad Docs: css tweaks
* Add vertical space between items in "open" lists
  (rtfd/sphinx_rtd_theme#590)
* Distinguish shell prompts in console examples,
  and omit them if the code is copied
* Add css and js extras directly from Sphinx conf.py
  (no need to override template)
2018-03-16 12:16:57 -07:00