summaryrefslogtreecommitdiff
path: root/doc/ext
Commit message (Collapse)AuthorAgeFilesLines
...
* | | | Merge branch 'stable'Takeshi KOMIYA2017-07-291-0/+7
|\ \ \ \ | |/ / / |/| / / | |/ /
| * | Fix #3926: Add ``autodoc_warningiserror`` to suppress the behavior of ``-W`` ↵Takeshi KOMIYA2017-07-151-0/+7
| | | | | | | | | | | | option
* | | doc: Add sphinx-autogen man pageStephen Finucane2017-07-111-0/+3
| | | | | | | | | | | | | | | | | | This wasn't documented in depth anywhere, so do just that. Signed-off-by: Stephen Finucane <stephen@that.guru>
* | | Merge branch 'stable'Takeshi KOMIYA2017-06-251-4/+10
|\ \ \ | |/ / | | / | |/ |/|
| * Improve access to table and math markup info in docsjfbu2017-06-201-0/+2
| |
| * Update docs regarding the CDN used by default for MathJaxjfbu2017-06-201-4/+8
| |
* | Fix #3638: Allow to change a label of reference to equationTakeshi KOMIYA2017-04-271-0/+7
|/
* Add image_converter_args confvalTakeshi KOMIYA2017-04-221-0/+5
|
* Add sphinx.ext.imgconverterTakeshi KOMIYA2017-04-222-0/+26
|
* update CHANGES refs #2961shimizukawa2017-04-191-0/+3
|
* ext: enhance autodoc_mock_importsRobin Jarry2017-04-181-1/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The autodoc_mock_imports option requires to explicitly declare *every* external module and sub-module that are imported by the documented code. This is not practical as the list can become very large and must be maintained as the code changes. Also, the mocking is minimal which causes errors when compiling the docs. For example, if you declare: autodoc_mock_imports = ['django.template'] And try to document a module: .. automodule:: my.lib.util Which contains this code: from django.template import Library register = Library() The following error occurs: File ".../my/lib/util.py" line 2 register = Library() TypeError: 'object' object is not callable Other similar errors can occur such as "TypeError: 'object' object has no len". To address these limitations, only require to declare the top-level module that should be mocked: autodoc_mock_imports = ['django'] Will mock "django" but also any sub-module: "django.template", "django.contrib", etc. Also, make the mocked modules yield more complete dummy objects to avoid these TypeError problems. Behind the scenes, it uses the python import hooks mechanism specified in PEP 302. Signed-off-by: Robin Jarry <robin@jarry.cc>
* Merge pull request #3388 from smheidrich/autosectionlabel_prefix_document1Takeshi KOMIYA2017-04-181-1/+15
|\ | | | | Added autosectionlabel_prefix_document config option
| * Added autosectionlabel_prefix_document config option.smheidrich2017-04-171-1/+15
| |
* | Merge branch 'stable'Takeshi KOMIYA2017-04-021-2/+21
|\ \
| * | BUG: Fix autosummary of members with a trailing underscoreEric Wieser2017-03-261-2/+21
| | |
| * | Fix #3174: [Napoleon] Defers autodoc-skip-member to other extensions if ↵Rob Ruana2017-03-141-0/+5
| | | | | | | | | | | | Napoleon doesn't care if the member is skipped
* | | fix style check warningsYoshiki Shibukawa2017-03-032-2/+2
| |/ |/|
* | From version 1.5 to 1.6. Warnings wrapped with locale.Marco Buttu2017-01-261-1/+1
| |
* | Fixed flake8 style checkMarco Buttu2017-01-161-1/+1
| |
* | Comparison made by distutils.version.LooseVersionMarco Buttu2017-01-151-1/+3
| |
* | compare_version() replaces proper_pyversion()Marco Buttu2017-01-151-2/+2
| |
* | Added pyversion option for doctest (issue 3303)Marco Buttu2017-01-151-1/+12
| | | | | | | | Code, tests and documentation.
* | Drop deprecated options for graphviz extensionTakeshi KOMIYA2017-01-051-13/+1
| |
* | Fix #3174: [Napoleon] Defers autodoc-skip-member to other extensions if ↵Rob Ruana2016-11-231-0/+5
| | | | | | | | Napoleon doesn't care if the member is skipped
* | #3136: Add ``:name:`` option to the directives in ``sphinx.ext.graphviz``Takeshi KOMIYA2016-11-121-0/+3
|/
* Fix #2474: Add ``intersphinx_timeout`` option to ``sphinx.ext.intersphinx``Takeshi KOMIYA2016-09-011-0/+11
|
* Fix document for Kindle and add description about kindlegenYoshiki Shibukawa2016-09-012-0/+59
|
* Python domain can now link container types automaticallyAshley Whetter2016-08-032-6/+6
| | | | | | | Google types now greedily match the closing parenthesis. Also removed name from returns section in Google docstrings. Instead, everything before the colon is treated as the type.
* Turn off viewcode extension by defaultYoshiki Shibukawa2016-07-281-0/+28
|
* Merge branch 'stable'Takeshi KOMIYA2016-07-212-2/+6
|\
| * fix document download roles. download roles works only on html.Yoshiki Shibukawa2016-07-192-2/+6
| |
* | #2680: `sphinx.ext.todo` now emits warnings if `todo_emit_warnings` enabledTakeshi KOMIYA2016-07-161-0/+15
| |
* | Fix style checksVille Skyttä2016-07-072-2/+2
| |
* | [Napoleon] Removes Python 2/3 compatible type annotation doc example, ↵Rob Ruana2016-07-021-18/+4
| | | | | | | | because they aren't current supported by Sphinx
* | Fixes #2688: [Napoleon] Updates to Napoleon documentation to fix intersphinx ↵Rob Ruana2016-06-233-47/+161
| | | | | | | | links and demonstrate PEP 484 type annotations
* | Fix #2537: [Napoleon] Corrects minor formatting issue on example NumPy ↵Rob Ruana2016-06-121-0/+1
| | | | | | | | Attributes section
* | Update #2374: [Napoleon] clarifies documentation of ↵Rob Ruana2016-06-111-0/+18
| | | | | | | | napoleon_include_init_with_doc conf value
* | #2575: Now ``sphinx.ext.graphviz`` allows ``:align:`` optionTakeshi KOMIYA2016-05-281-0/+4
| |
* | Merge branch 'stable'Takeshi KOMIYA2016-05-091-6/+12
|\ \ | |/
| * Split doctest extension docs into sectionsnevimov2016-05-021-6/+12
| | | | | | | | | | | | | | At the moment the docs have no sections at all. This commit adds sections "Directives" and "Configuration" to facilitate navigation. Also, it removes the outdated line about the number of directives provided by the extension (there’s now 5 of them).
* | Reformatted doc for doctest_default_flags (#2471).taschini2016-04-211-6/+9
| |
* | Incorporated feeback on doc for doctest_default_flags (#2471).taschini2016-04-211-11/+12
| |
* | Documenting doctest_default_flags config variable (#2471).taschini2016-04-211-7/+14
| |
* | fix #2379 - Keyword args rendered with type links, as normal parameters ↵Jan Duzinkiewicz2016-03-231-0/+16
| | | | | | | | (configurable under napoleon_use_keyword option)
* | Add ``:caption:`` option for sphinx.ext.inheritance_diagramTakeshi KOMIYA2016-03-111-0/+5
|/
* Fix highlight languages in docs.Georg Brandl2016-02-141-2/+8
|
* Fix #1286, #2099: Add ``sphinx.ext.autosectionlabel`` extension to allow ↵Takeshi KOMIYA2016-02-141-0/+25
| | | | reference sections using its title
* Merge pull request #2300 from akruis/feature_autoclass_content_from__new__Takeshi KOMIYA2016-02-141-0/+6
|\ | | | | Feature: enhance autoclass:: to use the docstring of __new__ if __init__ method's is missing of empty
| * Feature: enhance autoclass:: to use the docstring of __new__Anselm Kruis2016-02-051-0/+6
| | | | | | | | | | | | | | | | | | The method new is an alternative to __init__, but autoclass does not respect __new__. This commit enhances the directive autoclass:: to try __new__ method's docstring, if __init__ method's docstring is missing or empty. The commit also adds tests and updates the documentation.
* | Fixup links in the documentation.Georg Brandl2016-02-133-3/+3
| |
View Lorry Controller Status