Commit Graph

7 Commits

Author SHA1 Message Date
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 3d3d49b4dd Prepare for narrative docs (#275) 2017-10-26 17:55:45 +02:00
rtoijala 10368b4232 Some more typos (#219)
I went with the American spelling of "fulfill" instead of the British
"fulfil".
2017-07-20 17:30:20 +02:00
Hynek Schlawack 41d8cce09d Add a philosophy section (#73)
Also expand the example class a little bit to stress that we're not just
about data containers.
2016-08-30 12:12:02 +02:00
Hynek Schlawack 8ad7602992 More copyediting
The correct parts being based on feedback from @econchick
2016-08-17 13:28:00 +02:00
Hynek Schlawack 24e60944ec Add better serious business aliases 2016-08-16 12:18:03 +02:00
Hynek Schlawack b040503663 More documentation polish 2016-08-15 17:26:49 +02:00