Commit Graph

4 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
JesseWeinstein 2f9826c8dd Doc typo fixes (#56)
Native English speaker fixes
2016-08-15 10:00:23 +02:00
Hynek Schlawack 28204bef92 Deprecate Attribute instances on decorated classes
The changelog deprecation error explains it best.  It's to avoid
confusing errors if some attribute hasn't been initialized for whatever
reason (usually `init=False` + typo).
2016-08-08 12:11:06 +02:00
Hynek Schlawack f7597c795f Clarify backward compatibility + polish API docs 2015-02-01 19:27:36 +01:00