829c2ff15a
docs: improve RTD
2024-07-17 14:14:35 +02:00
f708291c4f
[pre-commit.ci] pre-commit autoupdate ( #1281 )
...
* [pre-commit.ci] pre-commit autoupdate
updates:
- [github.com/psf/black: 24.4.0 → 24.4.2](https://github.com/psf/black/compare/24.4.0...24.4.2 )
- [github.com/astral-sh/ruff-pre-commit: v0.4.1 → v0.4.3](https://github.com/astral-sh/ruff-pre-commit/compare/v0.4.1...v0.4.3 )
* Fix Sphinx warning
* pytest-mypy-plugins doesn't work on 3.13 yet
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Hynek Schlawack <hs@ox.cx>
2024-05-08 08:19:47 +00:00
2bddbdb704
Add codespell
2024-01-08 07:37:20 +01:00
bf357d6e67
Let's stand out
2023-11-23 08:28:31 +01:00
645b3023e8
Be clear in docs about in-dev
2023-07-09 14:25:19 +02:00
e048e1b9e3
Disable 404ing edit button
2023-07-09 11:47:23 +02:00
7c44cfb3c1
Fix intersphinx ( #1130 )
2023-04-26 18:31:29 -06:00
dadc020597
Fix links broken by pyright removing their transform spec
2023-04-16 12:15:50 +02:00
566248a2d8
Don't linkcheck tree links
2022-12-21 09:59:37 +01:00
0f6a9b4753
Add unsafe_hash alias for class-wide hash ( #1065 )
...
* Add unsafe_hash alias for class-wide hash
Fixes #1003
* Add news fragment
* Add type hints / type examples
* Complete attr.s's api string in api.rst
* Address feedback
* Clarify
* Shuffle around
2022-12-02 07:45:13 +01:00
95841fc93e
Start moving docs to MyST / Markdown ( #1053 )
...
* Start moving to MyST
* More MyST
* Start using proper typography
2022-11-16 13:58:25 +01:00
9169c49966
Add a preview for the "next release" change notes ( #1016 )
...
* Add a preview for the "next release" change notes
This change integrates `sphinxcontrib-towncrier` into the docs build.
It uses Towncrier and its configs to render a draft changelog as RST
and injects that into the `changelog.rst` document right above the
older changelog entries using `towncrier-draft-entries` directive.
* Drop the change note from PR #1016
This partially reverts commit 0165dc355d2eb475cf59894d1561efb9b1963a39.
* Use `Not yet released` in the changelog draft
Co-authored-by: Hynek Schlawack <hs@ox.cx>
2022-08-22 14:27:40 +00:00
d528dd4259
Fix more links
2021-12-28 06:47:51 +01:00
046beaaaaa
Apply SPDX IDs
2021-12-27 09:29:09 +01:00
38b299d4a4
Use importlib.metadata to find the version in Sphinx docs
2021-11-28 15:04:39 +01:00
d7d9c5dde7
Switch to NG APIs in docs ( #863 )
...
* Switch to NG APIs in docs
* Review feedback
* Convert examples.rst
* Tweak doctest
* Doctest fixes
* Tweak some more
* Fix
* Update docs/init.rst
Co-authored-by: Hynek Schlawack <hs@ox.cx>
* Fix doctest
* Fix README
* Update docs/examples.rst
Co-authored-by: Hynek Schlawack <hs@ox.cx>
* Review feedback
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Fix link
Co-authored-by: Hynek Schlawack <hs@ox.cx>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-11-22 07:35:36 +01:00
c4587c0793
Add missing author metadata
2021-11-15 10:08:16 +01:00
a76f750d77
We build docs only on Python 3
2021-11-15 09:59:21 +01:00
031ba36048
Add epub metadata
2021-11-15 09:58:33 +01:00
0a6f8075eb
add sphinx-notfound-page ( #777 )
...
Co-authored-by: Hynek Schlawack <hs@ox.cx>
2021-03-10 07:57:26 +01:00
446386a36d
Don't set pygments style
...
c.f. https://github.com/pradyunsg/furo/issues/68#issuecomment-752606308
2020-12-31 10:45:33 +01:00
32fb12789e
Add white logo for dark mode
...
Run both through svgo (saved 17.2% for white and 23% for black).
2020-11-16 07:52:35 +01:00
3d66e5727b
Exclude GitHub issues from linkcheck to avoid rate limits
2020-11-05 10:51:23 +01:00
9f2a7857dc
Furo works with SVG!
...
Fixes #674
2020-10-16 08:19:09 +02:00
ffe49c8241
Switch to furo
...
Now everything is @pradyunsg's fault! 🎉
Signed-off-by: Hynek Schlawack <hs@ox.cx>
2020-10-05 06:35:40 +01:00
2a1e8cf4da
Remove intersphinx mapping to zope.interface
...
One link is not worth a broken CI.
2020-03-29 14:40:25 +02:00
609b10e84f
Refactor docs and switch to RTD theme
...
Our API docs are much more readable on it.
Remove testimonials, they don't serve that much and take up space.
Slightly refactor main docs page.
2020-03-08 07:46:56 +01:00
8824dc26c2
Add default_role for Sphinx. ( #571 )
...
* Add default_role for Sphinx.
Fix a bunch of broken refs along the way, which become
errors now via -W if you have default_role set.
In theory you can catch those via sphinx-build -n (i.e.
nitpick mode), which IMHO is a decent idea anyhow, but it's
a longer diff to enable that because it'd involve fixing a
bunch of the places that try to reference types that don't
exist (e.g. :type foo: Any value). But obviously can be done.
Also didn't actually use this anywhere yet (the any role),
but will do so in a follow-up if this is acceptable.
* Remove the roles from builtin objects to demo any.
* Style.
* Add z.i to intersphinx.
Enables the link to z.i.Interface.
* Enable nitpick mode.
Fix the remaining broken links or whitelist them via nitpick_ignore.
* Kill all :func:s.
* Kill all :class:es.
* Kill all :doc:s.
* Kill all :ref:s.
Except one, that probably meant :func:, and which
is a duplicate ref.
* Kill :exc: and :data:.
* Kill :mod:s.
* Kill new explicit refs from the merge.
2019-09-09 15:02:16 +02:00
8e67bc748a
Use new alabaster feature to have rel bars
2018-06-19 12:49:25 +02:00
a372d51b7b
Fade to Black ( #392 )
2018-06-10 19:40:07 +02:00
0d2cd55ccd
Nicer heading
2017-11-08 17:23:56 +01:00
c5caba6050
Tune font stack
2017-11-08 16:38:47 +01:00
2a50c4b930
Get rid of serif pretentiosness
...
And some doc polish
2017-11-08 07:11:10 +01:00
1bb8fbd5ef
Add and use SVG version of our logo
2017-11-01 14:28:52 +01:00
ca34d804e9
Make theme less agist
2017-05-23 16:11:37 -07:00
b7919d0ddd
Fix doc build on sphinx 1.6.1
2017-05-22 16:16:12 -07:00
5171043475
Suppress non-local URI warning
2017-03-04 08:43:34 +01:00
10cd1950cb
We have a logo! ✨
2017-02-20 13:41:20 +01:00
0563f44b47
Move doc theme to alabaster
...
Reason is that the RTD theme looks weird for multi-paragraph parameter API
docs.
2017-02-12 08:48:35 +01:00
395aa07820
Documentation overhaul
2016-08-15 13:59:04 +02:00
a673093da3
Make copyright year static. ( #49 )
...
Thanks
2016-08-10 09:19:43 +02:00
4c39a185ad
Move package into src directory
...
Prevents accidental imports when running tests.
2015-10-16 15:11:10 +02:00
c7381fd0e2
Gut docs for now
2015-01-27 23:03:04 +01:00
9560908555
Initial commit
...
Docs aren't there yet
2015-01-27 17:53:17 +01:00
Hynek Schlawack