Commit Graph

24 Commits

Author SHA1 Message Date
Hynek Schlawack 58d2adce57
Document comparison (#768)
* Document comparison

* Grammar

* Stress independence of eq/order

* Add example for eq

* Be consistent with fields

* Update docs/comparison.rst

Co-authored-by: Julian Berman <Julian@GrayVines.com>

* Update docs/comparison.rst

Co-authored-by: Julian Berman <Julian@GrayVines.com>

* Update docs/comparison.rst

Co-authored-by: Julian Berman <Julian@GrayVines.com>

* Clarify

Co-authored-by: Julian Berman <Julian@GrayVines.com>
2021-02-26 07:53:57 +01:00
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 7b37354aa4
Add Python 2 statement (#498) 2019-02-10 07:32:19 +01:00
Hynek Schlawack a6955bff7d
Add narrative docs for type annotations (#406)
* Add narrative docs for type annotations

* Better wording

* Use better code-block types

* Add newsfragment for #238 that refers to these docs
2018-07-28 12:05:12 +01:00
Hynek Schlawack db7c37eda8
Add glossary & make slotted classes official (#371)
* Add glossary & make slotted classes official

* Add missing import
2018-05-02 07:24:04 +02:00
Hynek Schlawack 879f43d355 Add narrative chapter about initialization (#370)
* Add narrative chapter on initialization

* Be more explicit about defining validators both ways

* Stress that the name of default/validator != attr name

* Mention nested schemas

* Explain handling of private attributes

* Add another consequence of _ stripping

* Stress that nothing should overwrite attributes on class body

* Better wording

* typo

* Dedup examples

* Address review feedback

* Add newsfragments
2018-04-25 00:07:03 +02:00
Hynek Schlawack 57817b2c0e
Add a narrative chapter on object hashing (#369)
* Add a narrative chapter on object hashing

* Simplify

* Add a "what to do" to the tl;dr warning

* Shuffle around

* Fix typos
2018-04-16 07:49:34 +02:00
Hynek Schlawack 7501cecf0f m(
fixes #283
2017-11-08 19:21:26 +01:00
Hynek Schlawack 3d3d49b4dd Prepare for narrative docs (#275) 2017-10-26 17:55:45 +02:00
Hynek Schlawack 5e594ca580 We want to simplify writing classes; not attributes 2017-02-20 16:22:29 +01: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 563b09f19a Pull license up 2016-08-15 21:51:20 +02:00
Hynek Schlawack 5dd257f878 Treat main title as a title 2016-08-15 17:35:49 +02:00
Hynek Schlawack b040503663 More documentation polish 2016-08-15 17:26:49 +02:00
Hynek Schlawack 395aa07820 Documentation overhaul 2016-08-15 13:59:04 +02:00
Hynek Schlawack 27e2f4e5c0 Document how to extend attrs 2015-03-23 10:32:13 +01:00
Hynek Schlawack 1f5513e098 Shorten creed 2015-02-21 11:36:08 +01:00
Hynek Schlawack f7597c795f Clarify backward compatibility + polish API docs 2015-02-01 19:27:36 +01:00
Hynek Schlawack 2040ed5e48 Replace motto 2015-01-29 17:33:58 +01:00
Hynek Schlawack 8bfa3a3c6f Don't strip teaser 2015-01-29 09:13:16 +01:00
Hynek Schlawack 3f2fd8317d More doc polishing 2015-01-28 16:55:45 +01: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