summaryrefslogtreecommitdiff
path: root/doc/usage/extensions
Commit message (Collapse)AuthorAgeFilesLines
...
| * | | | | Support coverage_ignore_pyobjects in the coverage builderAdrián Chaves2019-05-151-0/+12
| | | | | |
* | | | | | Reorganize documentation of the imgmath configuration variablesjfbu2019-04-241-49/+58
| | | | | |
* | | | | | More robust code for getting saved "depth" of svg inline math snippetjfbu2019-04-241-11/+9
| | | | | |
* | | | | | Make imgmath_use_preview work also for svg outputjfbu2019-04-231-2/+3
|/ / / / /
* | | | | Address commentsAlex Sergeev2019-04-141-4/+7
| | | | |
* | | | | Address feedbackAlex Sergeev2019-04-131-2/+2
| | | | |
* | | | | Fix #6213: ifconfig: contents after headings are not shownTakeshi KOMIYA2019-04-051-0/+5
| | | | |
* | | | | Add missing versionadded for autosummary_mock_importsTakeshi KOMIYA2019-04-041-0/+2
| | | | |
* | | | | Merge pull request #6212 from tsanikgr/feature/autosummary_imported_membersTakeshi KOMIYA2019-04-041-0/+8
|\ \ \ \ \ | | | | | | | | | | | | Allow setting imported_members for autosummary in conf.py
| * | | | | Simplify docstsanikgr2019-04-031-6/+3
| | | | | |
| * | | | | #5877: Allow setting imported_members for autosummary in conf.pytsanikgr2019-03-271-0/+11
| |/ / / /
* | | | | Clarify MathJax extension usage: edits from reviewRichard Darst2019-03-291-7/+12
| | | | |
* | | | | Clarify MathJax extension usageRichard Darst2019-03-271-3/+6
|/ / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - We recently hit an issue where we expected the MathJax extension to work with the default MathJax markup. Obviously that shouldn't be the case (since then other formats couldn't use the math), but it can't hurt to include a hint. - Link from the math HTML extension page to the relevant roles/directives. - Also make it explicit that MathJax has a default, and that it's an external resource that will be dynamically linked.
* | | | Fix docs of inheritance-diagram "parts" optionMichael Goerz2019-03-191-6/+47
| |_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The documentation now correctly describes the behavior of the ``parts`` option in an inheritance-diagram directive: it gives the number of parts that are *kept* not dropped. The option now also accepts negative values, which drops parts from the left (which is the what the documentation incorrectly claimed the option would do for positive values) As a form of testing of the new functionality, the documentation for the inheritance_diagram extension now includes a section "Examples" that demonstrate the different possibilities. This would fail to build without the patch. Closes #4872
* | | docs: Remove a term "new" from config valuesTakeshi KOMIYA2019-02-276-6/+6
| |/ |/|
* | Closes #1148: autodoc: Add autodecorator directive for decoratorsTakeshi KOMIYA2019-02-151-1/+3
| |
* | Merge pull request #6064 from tk0miya/5636_add_autosummary_mock_importsTakeshi KOMIYA2019-02-141-0/+5
|\ \ | | | | | | Closes #5635: autosummary: Add autosummary_mock_imports to mock external libraries
| * | Closes #5636: autosummary: Add autosummary_mock_imports to mock external ↵Takeshi KOMIYA2019-02-111-0/+5
| | | | | | | | | | | | libraries
* | | docs: autosectionlabel_maxdepthTakeshi KOMIYA2019-02-111-0/+7
|/ /
* | Fix typoTakeshi KOMIYA2019-02-111-1/+1
| |
* | Merge pull request #6053 from tk0miya/5459_autodoc_default_options_accepts_TrueTakeshi KOMIYA2019-02-111-3/+6
|\ \ | | | | | | Closes #5459: autodoc: autodoc_default_options accepts True as a value
| * | Closes #5459: autodoc: autodoc_default_options accepts True as a valueTakeshi KOMIYA2019-02-111-3/+6
| |/
* | docs: githubpage now supports CNAME fileTakeshi KOMIYA2019-02-111-0/+6
|/
* Merge branch '1.8'jfbu2018-12-283-3/+3
|\ | | | | | | | | | | | | resolved Conflicts: doc/development/tutorials/todo.rst sphinx/locale/__init__.py sphinx/search/zh.py
| * Fix various spelling typosjfbu2018-12-273-3/+3
| |
* | doc: Fix description for viewcode_follow_imported_membersTakeshi KOMIYA2018-12-231-4/+3
| |
* | Remove unnecessary encoding cookie from Python source filesJon Dufresne2018-12-162-2/+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.
* | autodoc: Respect `member-order` in `autodoc_default_options` as documentedEric N. Vander Weele2018-10-161-3/+4
| | | | | | | | | | | | | | | | In the `autodoc_default_options` documentation, it mentions that `member-order` is respected; however, when setting the key-value pair in `conf.py`, it is not. Thus, add `member-order` as one of the default options respected in `conf.py`. Additionally, update the list of supported options to match the example.
* | Prefer https:// links where availableJon Dufresne2018-09-231-1/+1
| |
* | Fixes #5426: [Napoleon] Better handling of inline attributes (#5470)Rob Ruana2018-09-231-2/+2
| | | | | | | | | | | | | | | | * Fixes #5426: [Napoleon] Better handling of inline attributes * Removes uneeded NOQA comments * Fixes imports
* | Remove unnecessary object from class definitionsJon Dufresne2018-09-113-3/+3
| | | | | | | | | | In Python 3, all classes are new-style classes. The object in the definition is redundant and unnecessary.
* | Merge branch '1.8'Takeshi KOMIYA2018-09-051-0/+2
|\ \ | |/
| * doc: Add versionadded label (refs: #5029)Takeshi KOMIYA2018-09-031-0/+2
| |
* | Fix #4182: autodoc: Support :confval:`suppress_warnings`Takeshi KOMIYA2018-08-261-0/+17
|/
* Fix typoTakeshi KOMIYA2018-08-221-1/+1
|
* Merge pull request #5315 from tk0miya/add_autodoc_default_optionsTakeshi KOMIYA2018-08-201-23/+31
|\ | | | | Add autodoc_default_options
| * Add autodoc_default_optionsTakeshi KOMIYA2018-08-181-23/+31
| |
* | Merge pull request #5297 from AWhetter/viewcode_follow_imported_eventTakeshi KOMIYA2018-08-191-1/+15
|\ \ | |/ |/| Plugins can resolve imported members for viewcode
| * Plugins can resolve imported members for viewcodeAshley Whetter2018-08-131-1/+15
| |
* | autodoc: add 'exclude-members' to user global optionsLewis Haley2018-08-171-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As the previous commit explains, it is now possible to specify arguments to the global options in config files. This means that we can now include the `exclude-members` option in this global configuration. Previously, there was no point including this option because it makes no sense without arguments. Including this option means users have the flexibility of explicitly including which special methods they want using (e.g.): :special-members: __init__, __iter__ or explicitly excluding which special-members (or other members) they want using (e.g.): :exclude-members: __weakref__, __hash__
* | autodoc: allow specifying values to global argumentsLewis Haley2018-08-171-0/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, users could specify a *list* of flags in their config files. The flags were directive names that would otherwise be present in the .rst files. However, as a list, it was not possible to specify values to those flags, which *is* possible in .rst files. For example, in .rst you could say :special-members: __init__, __iter__ And this would cause autodoc to generate documents for these methods that it would otherwise ignore. This commit changes the config option to instead accept a dictionary. This is a dictionary whose keys can contain the same flag-names as before, but whose values can contain the arguments as seen in .rst files. The old list is still supported, for backwards compatibility, but the data is transformed into a dictionary when the user's config is loaded.
* | Ref #5273: doctest: add documentation for the :skipif: optionAntti Kaihola2018-08-161-0/+75
|/
* WIP: #726, #969: Add mathjax_configTakeshi KOMIYA2018-07-291-0/+17
|
* doc: Move description for math confval, directives and roles to usageTakeshi KOMIYA2018-07-281-111/+7
|
* Merge remote-tracking branch 'stephenfin/doc-rework'Takeshi KOMIYA2018-06-261-0/+7
|
* doc: Add "extensions" to usage guideStephen Finucane2018-06-2022-0/+3395
Signed-off-by: Stephen Finucane <stephen@that.guru>
View Lorry Controller Status