IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
8,497 Commits 2 Branches 219 Tags 163 MiB
621a4e6f61
Commit Graph

315 Commits

Author SHA1 Message Date
shimizukawa
de2cd652ab update CHANGES refs #2961 2017-04-19 16:28:56 +09:00
Robin Jarry
ececc4dcfe ext: enhance autodoc_mock_imports 
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>
 2017-04-18 17:08:17 +02:00
Takeshi KOMIYA
690f07fa3c Merge pull request #3388 from smheidrich/autosectionlabel_prefix_document1 
Added autosectionlabel_prefix_document config option
 2017-04-18 01:16:00 +09:00
smheidrich
231976ff14 Added autosectionlabel_prefix_document config option. 2017-04-17 14:51:39 +02:00
Takeshi KOMIYA
fc41f43a70 Merge branch 'stable' 2017-04-02 19:05:50 +09:00
Eric Wieser
804891c4a1 BUG: Fix autosummary of members with a trailing underscore 2017-03-26 12:54:03 +01:00
Rob Ruana
b7efbfe615 Fix #3174: [Napoleon] Defers autodoc-skip-member to other extensions if Napoleon doesn't care if the member is skipped 2017-03-14 18:53:27 -07:00
Yoshiki Shibukawa
7e178785a7 fix style check warnings 2017-03-03 22:03:16 +09:00
Marco Buttu
882bebf90a From version 1.5 to 1.6. Warnings wrapped with locale. 2017-01-26 11:20:24 +01:00
Marco Buttu
e32eb44959 Fixed flake8 style check 2017-01-16 10:53:46 +01:00
Marco Buttu
df1c46974d Comparison made by distutils.version.LooseVersion 2017-01-15 22:09:15 +01:00
Marco Buttu
44732c6aea compare_version() replaces proper_pyversion() 2017-01-15 21:07:44 +01:00
Marco Buttu
960f889a2c Added pyversion option for doctest (issue 3303) 
Code, tests and documentation.
 2017-01-15 10:27:34 +01:00
Takeshi KOMIYA
099daa602b Drop deprecated options for graphviz extension 2017-01-05 13:52:17 +09:00
Rob Ruana
f45fe6fc8c Fix #3174: [Napoleon] Defers autodoc-skip-member to other extensions if Napoleon doesn't care if the member is skipped 2016-11-23 10:45:39 -08:00
Takeshi KOMIYA
22545a0927 #3136: Add `:name: option to the directives in sphinx.ext.graphviz` 2016-11-12 23:05:59 +09:00
Takeshi KOMIYA
4063a67d19 Fix #2474: Add `intersphinx_timeout option to sphinx.ext.intersphinx` 2016-09-01 23:00:31 +09:00
Yoshiki Shibukawa
0248416c65 Fix document for Kindle and add description about kindlegen 2016-09-01 12:46:12 +09:00
Ashley Whetter
cfd4e51802 Python domain can now link container types automatically 
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.
 2016-08-03 17:09:40 +01:00
Yoshiki Shibukawa
d842a4cbc8 Turn off viewcode extension by default 2016-07-28 15:38:38 +09:00
Takeshi KOMIYA
80bfc55795 Merge branch 'stable' 2016-07-21 00:20:25 +09:00
Yoshiki Shibukawa
702004acfc fix document download roles. download roles works only on html. 2016-07-19 23:15:35 +09:00
Takeshi KOMIYA
253eef9e6a #2680: sphinx.ext.todo now emits warnings if todo_emit_warnings enabled 2016-07-16 00:59:02 +09:00
Ville Skyttä
7cfbc2a702 Fix style checks 2016-07-07 16:48:12 +03:00
Rob Ruana
8eecdbd715 [Napoleon] Removes Python 2/3 compatible type annotation doc example, because they aren't current supported by Sphinx 2016-07-02 11:43:55 -04:00
Rob Ruana
2b60fc2027 Fixes #2688: [Napoleon] Updates to Napoleon documentation to fix intersphinx links and demonstrate PEP 484 type annotations 2016-06-23 15:25:46 -04:00
Rob Ruana
ff34d02beb Fix #2537: [Napoleon] Corrects minor formatting issue on example NumPy Attributes section 2016-06-12 14:55:39 -06:00
Rob Ruana
32a852c1f1 Update #2374: [Napoleon] clarifies documentation of napoleon_include_init_with_doc conf value 2016-06-11 18:28:48 -06:00
Takeshi KOMIYA
1d17475a08 #2575: Now `sphinx.ext.graphviz allows :align:` option 2016-05-28 18:29:10 +09:00
Takeshi KOMIYA
c9296ba467 Merge branch 'stable' 2016-05-09 10:11:13 +09:00
nevimov
0960f0d9f2 Split doctest extension docs into sections 
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).
 2016-05-02 02:02:55 +07:00
taschini
80bbdd4998 Reformatted doc for doctest_default_flags (#2471). 2016-04-21 14:17:43 +02:00
taschini
604b45d44b Incorporated feeback on doc for doctest_default_flags (#2471). 2016-04-21 12:35:36 +02:00
taschini
8c1d9cc71c Documenting doctest_default_flags config variable (#2471). 2016-04-21 12:07:00 +02:00
Jan Duzinkiewicz
d8cd3ec4be fix #2379 - Keyword args rendered with type links, as normal parameters (configurable under napoleon_use_keyword option) 2016-03-23 19:30:14 +01:00
Takeshi KOMIYA
d86ea47b52 Add `:caption:` option for sphinx.ext.inheritance_diagram 2016-03-11 13:20:05 +09:00
Georg Brandl
d59f23b2c8 Fix highlight languages in docs. 2016-02-14 09:37:55 +01:00
Takeshi KOMIYA
7a4f914f91 Fix #1286, #2099: Add `sphinx.ext.autosectionlabel` extension to allow reference sections using its title 2016-02-14 16:30:57 +09:00
Takeshi KOMIYA
dca1669b2f Merge pull request #2300 from akruis/feature_autoclass_content_from__new__ 
Feature: enhance autoclass:: to use the docstring of __new__ if __init__ method's is missing of empty
 2016-02-14 14:45:25 +09:00
Georg Brandl
5e8642983b Fixup links in the documentation. 2016-02-13 16:00:46 +01:00
shimizukawa
e2208c12a0 Update CHANGES and documentation for #1751. 2016-02-08 23:31:02 +09:00
Anselm Kruis
0311f33347 Feature: enhance autoclass:: to use the docstring of __new__ 
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.
 2016-02-05 19:09:43 +01:00
Hong Xu
540400635a math: Add math_number_all to enforce numbering all displayed math. 2016-01-18 23:47:01 -08:00
Takeshi KOMIYA
0cbb29e342 Update docs for #2221 2016-01-19 00:53:10 +09:00
Takeshi KOMIYA
4c4450d958 Fix #656: Add `graphviz_dot option to graphviz directives to switch the dot` command 2016-01-18 23:56:05 +09:00
shimizukawa
f824539119 merge with stable 2016-01-13 00:13:35 +09:00
Takeshi KOMIYA
8ea92359ba Fix warnings in CHANGES and docs 2016-01-12 13:36:12 +09:00
shimizukawa
e5860fd75c Merge with '87998df9cbef2380345d436121e6bca43345d2bd' on stable 
Conflicts:
	tests/test_build_latex.py
 2016-01-10 10:21:27 +09:00
Takeshi KOMIYA
0ea518d563 Add sphinx.ext.githubpages to publish the docs on GitHub Pages 2016-01-06 22:14:57 +09:00
Hong Xu
f233c604ef imgmath: Make the size of the displayed math customizable. 2015-12-29 15:14:04 -08:00