summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Use .. caution:: to warn about the the old class-advice based APIsdocs-in-py3Marius Gedminas2019-11-111-3/+3
|
* Move the @provider example into the right sectionMarius Gedminas2019-11-111-9/+8
| | | | | | | | | Explain that implements()/implementsOnly()/classProvides() not only should not be "preferred", but are entirely not functional on Python 3. (These notes should probably use some Sphinx directive to stand out better, but I'm not well versed in Sphinx and I don't know which one I should use.)
* Port the documentation examples to Python 3Marius Gedminas2019-11-116-160/+187
|
* Update README.ru.rstSerjio Razin2019-02-121-23/+22
| | | | - Punctuation check and fix. - Replace some figures of speech.
* Update README.ru.rstSerjio Razin2019-02-111-1/+1
| | | Fixed typo
* Cross ref from ISpecification to IDeclaration.Jason Madden2018-07-191-13/+14
|
* Reorganize the 'declarations' document by functional group.Jason Madden2018-07-191-489/+401
| | | | Add cross references and some formatting fixes.
* Formatting and cross refs for the 'Interface Specification' docJason Madden2018-07-191-12/+28
|
* Formatting and cross refs for IComponents.Jason Madden2018-07-191-1/+8
|
* Basic API reference documentation reorg: split into four functional parts.Jason Madden2018-07-197-301/+398
| | | | Add some missing documentation for the events component registries create.
* Add docstrings with cross-refs to z.i.common.interfacesJason Madden2018-07-191-1/+2
| | | | | | Also bring the ``classImplements`` lines closer to the interface declaration. This helped me be sure that nothing was missed and that all the repetitions of the names matched.
* Basic automodule directives for the modules in zope.interface.common.Jason Madden2018-07-192-0/+31
|
* Standarize the ReST headers in api.rst.Jason Madden2018-07-191-68/+69
|
* Merge pull request #110 from zopefoundation/roto-drop-py33Joni Orponen2017-12-291-4/+3
|\ | | | | Drop testing and pypi-declared support of Python 3.3
| * Simplify and future-proof tox usage documentation.roto-drop-py33Joni Orponen2017-12-281-4/+3
| |
* | Add changelog to RTDMichael Howitz2017-12-152-0/+2
|/ | | | | Render the changelog on RTD so the whole documentation is there together. No need to look up the changes on PyPI or GH.
* Fix hardcoded version number in Sphinx docsMarius Gedminas2017-12-141-4/+9
|
* Use LuaLaTeXfix-latex-docsMarius Gedminas2017-12-071-1/+5
| | | | | | See http://www.sphinx-doc.org/en/stable/config.html#confval-latex_engine Ought to fix #111, provided that ReadTheDocs supports LuaLaTeX.
* Fix sentence in READMENiels Bom2017-03-201-1/+1
| | | Classes (factories) _implement_, objects _provide_. After first carefully explaining the difference, the docs mix them up.
* Expose IComponent documentation.Jason Madden2017-01-053-8/+41
|
* Document API for adapter registry.Tres Seaver2016-12-062-0/+21
| | | | Closes: #41.
* Editing while reading, and spell out Require and ProvideJean Jordaan2016-10-161-121/+121
| | | | | Changing IR to IRequire (or IRequired?) feels much more readable to me ..
* Editing while reading: literals, typos, grammarJean Jordaan2016-10-165-99/+99
|
* Merge branch 'doc_tweaks' of https://github.com/msabramo/zope.interface into ↵Tres Seaver2016-03-241-4/+4
|\ | | | | | | msabramo-doc_tweaks
| * docs/README.rst: Small tweaksMarc Abramowitz2015-01-261-4/+4
| |
* | Drop mention of 'python2.6' from 'docs/hacking.txt'.Tres Seaver2016-03-091-4/+4
|/ | | | | Addresses: https://github.com/zopefoundation/zope.interface/pull/33#issuecomment-194454496
* Silence Sphinx warning.Tres Seaver2015-01-221-0/+0
|
* Remove SVN fossilTres Seaver2015-01-211-1/+1
|
* Edit myself out in favor of J. Random Hacker.Tres Seaver2015-01-201-2/+2
| | | | [ci skip]
* Remove no-longer true mention of building docs in buildout.Tres Seaver2015-01-191-36/+0
|
* Remove stray line.Tres Seaver2015-01-191-1/+0
| | | | [ci skip]
* Update hacking docs to reflect Github.Tres Seaver2015-01-111-41/+48
|
* Fix typo.Stephan Richter2014-02-051-1/+1
|
* Added an API doc entry for the new "@named()" function.Stephan Richter2014-02-051-0/+30
|
* Remove trailing whitespace.Stephan Richter2014-02-051-8/+9
|
* Typo + note docs built by full tox run.Tres Seaver2012-06-291-3/+4
|
* Document running tests / building docs via tox.Tres Seaver2012-06-271-0/+81
|
* Run Sphinx commands directly, rather than via 'make'.Tres Seaver2012-06-271-12/+6
| | | | Fix a coupld of ReST typos.
* Fix docs version.Tres Seaver2012-06-271-2/+2
|
* Fix up snippets to run in Sphinx context.Tres Seaver2012-04-066-281/+613
|
* Move commented-out doctest snippets into API docs as real snippets.Tres Seaver2012-04-061-2/+948
|
* Include repoze.sphinx.autointerface for building docs.Tres Seaver2012-04-061-1/+9
|
* Add page for API docs.Tres Seaver2012-04-062-0/+20
|
* Ensure that all doctest blocks get recognized by Sphinx.Tres Seaver2012-04-063-7/+11
|
* Merge Py3k w/o 2to3 work.Tres Seaver2012-04-041-8/+8
|
* Add hacking docs.Tres Seaver2012-03-262-0/+268
|
* Merge from LP branch.Tres Seaver2012-03-2612-0/+3838
View Lorry Controller Status