Commit Graph

18 Commits

Author SHA1 Message Date
Hynek Schlawack 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
Julian Berman 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
Hynek Schlawack 8e67bc748a Use new alabaster feature to have rel bars 2018-06-19 12:49:25 +02:00
Hynek Schlawack a372d51b7b
Fade to Black (#392) 2018-06-10 19:40:07 +02:00
Hynek Schlawack 0d2cd55ccd Nicer heading 2017-11-08 17:23:56 +01:00
Hynek Schlawack c5caba6050 Tune font stack 2017-11-08 16:38:47 +01:00
Hynek Schlawack 2a50c4b930 Get rid of serif pretentiosness
And some doc polish
2017-11-08 07:11:10 +01:00
Hynek Schlawack 1bb8fbd5ef Add and use SVG version of our logo 2017-11-01 14:28:52 +01:00
Hynek Schlawack ca34d804e9 Make theme less agist 2017-05-23 16:11:37 -07:00
Hynek Schlawack b7919d0ddd Fix doc build on sphinx 1.6.1 2017-05-22 16:16:12 -07:00
Hynek Schlawack 5171043475 Suppress non-local URI warning 2017-03-04 08:43:34 +01:00
Hynek Schlawack 10cd1950cb We have a logo! 2017-02-20 13:41:20 +01:00
Hynek Schlawack 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
Hynek Schlawack 395aa07820 Documentation overhaul 2016-08-15 13:59:04 +02:00
Tristan Seligmann a673093da3 Make copyright year static. (#49)
Thanks
2016-08-10 09:19:43 +02:00
Hynek Schlawack 4c39a185ad Move package into src directory
Prevents accidental imports when running tests.
2015-10-16 15:11:10 +02:00
Hynek Schlawack c7381fd0e2 Gut docs for now 2015-01-27 23:03:04 +01:00
Hynek Schlawack 9560908555 Initial commit
Docs aren't there yet
2015-01-27 17:53:17 +01:00