summaryrefslogtreecommitdiff
path: root/sphinx/util/docstrings.py
Commit message (Collapse)AuthorAgeFilesLines
* Close #6830: autodoc: consider a member private if docstring has "private" ↵Takeshi KOMIYA2020-01-041-1/+31
| | | | metadata
* A happy new year!Takeshi KOMIYA2020-01-011-1/+1
|
* Migrate to py3 style type annotation: sphinx.util.docstringsTakeshi KOMIYA2019-06-021-8/+3
|
* Fix #6165: autodoc: ``tab_width`` setting of docutils has been ignoredTakeshi KOMIYA2019-04-251-3/+3
|
* Merge branch '1.8'Takeshi KOMIYA2019-01-021-1/+1
|\
| * A happy new year!Takeshi KOMIYA2019-01-021-1/+1
| |
* | Remove unnecessary encoding cookie from Python source filesJon Dufresne2018-12-161-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | In Python 3, the default encoding of source files is utf-8. The encoding cookie is now unnecessary and redundant so remove it. For more details, see the docs: https://docs.python.org/3/howto/unicode.html#the-string-type > The default encoding for Python source code is UTF-8, so you can > simply include a Unicode character in a string literal ... Includes a fix for the flake8 header checks to stop expecting an encoding cookie.
* | Replace all "unicode" type by "str"Takeshi KOMIYA2018-12-151-3/+2
| |
* | Add sphinx.util.typing:unicode to help mypy-3 migrationTakeshi KOMIYA2018-11-241-0/+1
|/
* Revert "Use typing.TYPE_CHECKING for typehints"Takeshi KOMIYA2018-03-131-3/+2
| | | | This reverts commit a073e17537c2aacaac305feadea58d4473ec97f4.
* Use typing.TYPE_CHECKING for typehintsTakeshi KOMIYA2018-02-141-2/+3
|
* A happy new year!Takeshi KOMIYA2018-01-011-1/+1
|
* Merge branch 'stable'Takeshi KOMIYA2017-03-261-1/+1
|\
| * Year++Takeshi KOMIYA2017-03-261-1/+1
| |
* | Upgrade to mypy-0.5Takeshi KOMIYA2017-03-031-0/+4
| |
* | Fix mypy violationsTakeshi KOMIYA2017-02-081-0/+2
|/
* Obligatory copyright update.Georg Brandl2016-01-141-1/+1
|
* Merge branch 'stable'Georg Brandl2015-01-031-1/+1
|\
| * all: update copyrightGeorg Brandl2015-01-031-1/+1
| |
* | merge with stableGeorg Brandl2014-11-071-1/+2
|\ \ | |/
| * Fix :confval:`autodoc_docstring_signature` not working with signaturesGeorg Brandl2014-11-071-1/+2
| | | | | | | | in class docstrings.
* | Update copyright year.Georg Brandl2014-03-011-1/+1
|\ \ | |/
| * Update copyright year.Georg Brandl2014-03-011-1/+1
| |
* | Modernize the code now that Python 2.5 is no longer supportedDmitry Shachnev2014-01-191-2/+2
|/ | | | | | | | | | | - Use print function instead of print statement; - Use new exception handling; - Use in operator instead of has_key(); - Do not use tuple arguments in functions; - Other miscellaneous improvements. This is based on output of `futurize --stage1`, with some manual corrections.
* Copyright update.Georg Brandl2013-01-011-1/+1
|
* merge with 1.0Georg Brandl2011-01-041-1/+1
|\
| * New year update.Georg Brandl2011-01-041-1/+1
| |
* | Fix docstring preparation with included signature: ignore indentation of two ↵Georg Brandl2011-01-041-12/+15
| | | | | | | | lines when looking for the signature.
* | Docstring harmonization.Georg Brandl2010-08-221-8/+7
|/
* Happy new year!Georg Brandl2010-01-011-1/+1
|
* attribute documentation now overrides non attribute documentation.Armin Ronacher2009-02-051-2/+6
| | | | | | | | | | | | This makes it possible to document aliased methods and other things:: def foo(self): pass #: an alias for foo() foo_alias = foo Also attribute documentation can contain paragraphs now.
* Fix a few remaining copyrights and add 2009 to license.Georg Brandl2009-01-041-1/+1
|
* Move docstring processing to an util module.Georg Brandl2008-12-301-0/+56