Takeshi KOMIYA
f5b1aff2d1
Merge branch 'master' into 4183_follow_pep440
2018-01-13 13:12:32 +09:00
Takeshi KOMIYA
12a8d5c0bd
doc: make looks understandable
2018-01-13 11:09:27 +09:00
Takeshi KOMIYA
76c5395c5b
Merge remote-tracking branch 'atodorov/inheritance_top_class'
2018-01-13 11:08:31 +09:00
Takeshi KOMIYA
7ba54500fc
Fix #4183 : doctest: `:pyversion:` option also follows PEP-440 specification
2018-01-08 11:59:50 +09:00
Jon Dufresne
cc3abba171
Prefer https & readthedocs.io instead of readthedocs.org for links
...
Read the Docs moved hosting to readthedocs.io instead of
readthedocs.org. Fix all links in the project.
For additional details, see:
https://blog.readthedocs.com/securing-subdomains/
> Starting today, Read the Docs will start hosting projects from subdomains on
> the domain readthedocs.io, instead of on readthedocs.org. This change
> addresses some security concerns around site cookies while hosting user
> generated data on the same domain as our dashboard.
2018-01-07 09:10:27 -08:00
Jean-François B
f5dfdfcfe2
Merge pull request #4332 from jfbu/latex_math_numfig
...
Let LaTeX obey :confval:`math_numfig` for equation numbering
2017-12-21 19:32:10 +01:00
jfbu
8cbd66f822
Trim docs about math_numfig
2017-12-21 18:47:35 +01:00
jfbu
3bb61e9094
Let LaTeX obey :confval:math_numfig for equation numbering
2017-12-21 12:23:20 +01:00
Kevin Keating
e932ff5ad2
Closes #947 : autodoc now supports ignore-module-all to ignore a module's __all__
2017-12-20 15:07:33 -05:00
Takeshi KOMIYA
e2bf2ef11d
Merge pull request #4166 from jahn/math_numfig
...
Number equations across pages and by section (fix #3991 , #4080 )
2017-12-21 00:39:44 +09:00
Oliver Jahn
9a39295291
add version
2017-12-18 06:41:50 -05:00
Oliver Jahn
56d4e0c80d
make math_numfig default to True
2017-12-17 14:02:32 -05:00
Oliver Jahn
27285dfeed
use :rst:role: markup
2017-12-17 13:56:06 -05:00
Takeshi KOMIYA
41f9cb200a
Fix doc: now eq role works whole of project
2017-12-17 23:44:28 +09:00
Oliver Jahn
44708b03dc
Merge branch 'master' into math_numfig
2017-12-16 11:15:07 -05:00
Oliver Jahn
04f2929f59
mention limitation to html-like targets
2017-12-16 10:37:02 -05:00
Takeshi KOMIYA
d003707f71
Merge branch 'stable'
2017-12-16 14:54:58 +09:00
jfbu
b131c33af5
Fix markup in doc/ext/math.rst
2017-12-15 22:54:52 +01:00
jfbu
ad4481eb15
Merge branch 'stable'
2017-12-11 22:54:34 +01:00
Takeshi KOMIYA
4abe6cb62e
Fix #4221 : napoleon depends on autodoc, but users need to load it manually
2017-11-11 21:53:20 +09:00
Oliver Jahn
7fc43d3365
use numfig for numbering equations by section rather than page
2017-10-18 16:52:28 -04:00
Takeshi KOMIYA
8b76d5b064
Merge pull request #4012 from avalentino/docstring-inheritance
...
Docstring inheritance
2017-08-21 23:31:17 +09:00
Takeshi KOMIYA
05b621a79a
Merge pull request #3961 from gaborbernat/master
...
fixes #3959 alias/rename support for classes inside inheritence diagrams
2017-08-20 00:41:50 +09:00
Antonio Valentino
620491fcd5
Retireve docstirng form base classes ( Closes #3140 )
2017-08-18 11:37:11 +02:00
Timotheus Kampik
83155ddf7f
#3978 fix typo
2017-08-05 13:50:26 +02:00
Bernat Gabor
0c3f9851b3
fixes #3959 alias/rename support for classes inside inheritence diagrams
2017-07-31 18:21:05 +01:00
Takeshi KOMIYA
abaf1cbb6b
Merge branch 'stable'
2017-07-29 16:01:47 +09:00
Takeshi KOMIYA
bfd71cd77b
Fix #3926 : Add `autodoc_warningiserror to suppress the behavior of -W` option
2017-07-15 22:04:56 +09:00
Stephen Finucane
65a81e2056
doc: Add sphinx-autogen man page
...
This wasn't documented in depth anywhere, so do just that.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:40 +01:00
Takeshi KOMIYA
e57fb74ee5
Merge branch 'stable'
2017-06-25 01:48:23 +09:00
jfbu
adc056200c
Improve access to table and math markup info in docs
2017-06-20 15:57:32 +02:00
jfbu
6f283d6879
Update docs regarding the CDN used by default for MathJax
2017-06-20 00:20:22 +02:00
Mr. Senko
9486f0d8f7
Add top-classes option to sphinx.ext.inheritance_diagram
...
This will limit the scope of inheritance traversal
2017-06-05 21:52:21 +03:00
Takeshi KOMIYA
a252954ea3
Fix #3638 : Allow to change a label of reference to equation
2017-04-27 21:47:20 +09:00
Takeshi KOMIYA
2b9b4f92a5
Add image_converter_args confval
2017-04-22 13:29:17 +09:00
Takeshi KOMIYA
c525723807
Add sphinx.ext.imgconverter
2017-04-22 13:29:16 +09:00
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
