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
10,144 Commits 2 Branches 219 Tags 163 MiB
c9fcaa3c14
Commit Graph

10144 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
de023f2dc0 Fix #3620: html theme: move DOCUMENTATION_OPTIONS to independent JavaScript file (refs: #3620) 2018-01-14 23:31:30 +09:00
Takeshi KOMIYA
0d61b251c5 Update CHANGES for PR #4413 2018-01-14 23:10:04 +09:00
Takeshi KOMIYA
b296487197
Merge pull request #4413 from rjarry/autodoc-mock-imports 
autodoc: only mock specified modules with their descendants.
 2018-01-14 23:05:06 +09:00
Takeshi KOMIYA
cf489c4b7e
Merge pull request #4202 from tk0miya/4196_emit_warning_for_tabularcolumn 
Emit warning if both tabularcolumns and :widths: are given (refs: #4196)
 2018-01-14 22:42:30 +09:00
Jean-François B
9397333616
Merge pull request #4429 from jfbu/leaner_visitfigure 
Remove unneeded coding from LaTeXTranslator.visit_figure()
 2018-01-14 14:42:13 +01:00
Takeshi KOMIYA
c399357f38 Show a notice if both tabularcolumns and :widths: are given (refs: #4196) 2018-01-14 22:23:18 +09:00
Takeshi KOMIYA
122a404eb3
Merge pull request #4427 from timhoffm/quickstart-conf2 
Minor conf.py cleanup
 2018-01-14 22:20:22 +09:00
jfbu
8b74d93ad9 Remove unneeded coding from LaTeXTranslator.visit_figure() 2018-01-14 10:32:47 +01:00
Takeshi KOMIYA
cdb31585a8 Merge branch 'master' into sphinx-build-set-proc-count-to-cpu-count 2018-01-14 09:39:48 +09:00
Robin Jarry
c24dffc5a8 autodoc: only mock specified modules with their descendants 
Do not mock the ancestors of the specified modules in
autodoc_mock_imports. Only mock the modules themselves and their
descendants (as specified in the docs).

Fix the test configs accordingly.

Signed-off-by: Robin Jarry <robin@jarry.cc>
 2018-01-13 17:24:02 +01:00
Takeshi KOMIYA
ac200ecf7c Update CHANGES 2018-01-14 01:05:52 +09:00
Tim Hoffmann
87b03bf76f minor conf.py cleanup 2018-01-13 15:52:50 +01:00
Takeshi KOMIYA
f3f829664d
Merge pull request #4424 from tk0miya/4079_notranslate 
Fix #4079: Add notranslate class to let Google Translate know they are not translatable
 2018-01-13 22:09:52 +09:00
Takeshi KOMIYA
fa9612801e
Merge branch 'master' into 4079_notranslate 2018-01-13 21:49:14 +09:00
Takeshi KOMIYA
6f1dc9b2be
Merge branch 'master' into 4079_notranslate 2018-01-13 21:46:50 +09:00
Takeshi KOMIYA
3663275755 Update CHANGES for PR #4245 2018-01-13 21:42:18 +09:00
Takeshi KOMIYA
553c92093d
Merge pull request #4245 from Blendify/patch-1 
Themes: Add language to javascript vars list
 2018-01-13 21:35:26 +09:00
Takeshi KOMIYA
fa51a637a8 shebang line is removed from generated conf.py (refs: #4385) 2018-01-13 21:00:13 +09:00
Takeshi KOMIYA
70d0a7bc3d
Merge pull request #4385 from timhoffm/quickstart-conf 
Updates to conf.py generated by sphinx-quickstart
 2018-01-13 20:56:19 +09:00
Takeshi KOMIYA
4d040abafb Fix #4079: Add notranslate class to let Google Translate know they are not translatable 2018-01-13 20:25:49 +09:00
Takeshi KOMIYA
f57634a8b8 Fix mark up 2018-01-13 19:08:23 +09:00
Takeshi KOMIYA
db361c3851 Update CHANGES for PR #4354 2018-01-13 18:42:48 +09:00
Takeshi KOMIYA
decbf20ccf
Merge pull request #4354 from stephenfin/builder-success-message 
Add 'Builder.epilog' attribute
 2018-01-13 18:39:29 +09:00
Jean-François B
43a097f17e
Merge pull request #4417 from jfbu/no_release_latex_header 
Eliminate comma from PDF header when project has no release number
 2018-01-13 09:09:12 +01:00
jfbu
f2bc93859a Remove unused and undocumented LaTeX macro `\shortversion` 2018-01-13 08:53:16 +01:00
Takeshi KOMIYA
f8dec55447 Update docstring 2018-01-13 15:53:15 +09:00
Takeshi KOMIYA
840b5828e7 docs: Add `-j auto` option 2018-01-13 15:50:26 +09:00
Takeshi KOMIYA
9c1bbf1948 Fix jobs_argument() should accept string as an argument 2018-01-13 15:44:56 +09:00
Takeshi KOMIYA
6d29b38140 Merge branch 'master' into sphinx-build-set-proc-count-to-cpu-count 2018-01-13 15:26:21 +09:00
Takeshi KOMIYA
822a04de9c
Merge pull request #4423 from tk0miya/3570_drop_typing_from_typehints 
Fix #3570: autodoc: Do not display typing. module for type hints
 2018-01-13 15:19:00 +09:00
Takeshi KOMIYA
0c5a47960f
Merge branch 'master' into 3570_drop_typing_from_typehints 2018-01-13 14:44:26 +09:00
Takeshi KOMIYA
c50b21af0e
Merge branch 'master' into 3570_drop_typing_from_typehints 2018-01-13 14:43:31 +09:00
Takeshi KOMIYA
2324dee143 Update CHANGES for PR #4235 2018-01-13 14:29:54 +09:00
Takeshi KOMIYA
7e365d97ac
Merge pull request #4235 from anarcat/manpage-links 
add link to manpages in HTML builder
 2018-01-13 14:28:11 +09:00
Takeshi KOMIYA
854a227501
Merge pull request #4393 from tk0miya/4183_follow_pep440 
Fix #4183: doctest: ``:pyversion:`` option also follows PEP-440 specification
 2018-01-13 14:26:33 +09:00
Takeshi KOMIYA
f5b1aff2d1
Merge branch 'master' into 4183_follow_pep440 2018-01-13 13:12:32 +09:00
Takeshi KOMIYA
7292386a03 Fix #3570: autodoc: Do not display typing. module for type hints 2018-01-13 12:08:31 +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
Sergey B Kirpichev
b1c100ca3b autodoc: make full reference for classes, aliased with "alias of" 
We do this here only if class belongs to the different module.

Closes sphinx-doc/sphinx#2437
 2018-01-13 00:19:19 +03:00
jfbu
8f2d4bae86 Eliminate comma from PDF header when project has no release number 2018-01-12 18:55:00 +01:00
Takeshi KOMIYA
3b01697e11
Merge pull request #4414 from deoren/link_label_fix 
Small label/comma fix
 2018-01-12 10:26:13 +09:00
deoren
32aa664bdf Small label/comma fix 2018-01-11 15:19:04 -06:00
Stephen Finucane
b16fd2ce01 make.bat: Make SOURCEDIR configurable 
It's unlikely that anyone will need to do this but at least give them
the opportunity.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-11 20:57:03 +00:00
Stephen Finucane
f6a045d171 Makefile: Make SOURCEDIR configurable 
It's unlikely that anyone will need to do this but at least give them
the opportunity.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-11 20:57:03 +00:00
Stephen Finucane
6f9a262f45 make.bat: Remove unnecessary targets 
As with the Makefile previously, these are not necessary now that we're
not printing anything different for various builders.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-11 20:57:03 +00:00
Stephen Finucane
aa2c5c9065 Makefile: Remove unnecessary targets 
Most of these are not necessary now that we're not printing different
messages for various builders.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-11 20:57:03 +00:00
Stephen Finucane
221dffda3c make_mode: Remove unnecessary 'make_*' functions 
These are handled by the default case.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-11 20:57:03 +00:00
Stephen Finucane
a83e8bab7d builders: Add 'Builder.epilog' option 
This allows builders to emit a final epilog message containing
information such as where resulting files can be found. This is only
emitted if the build was successful.

This allows us to remove this content from the 'make_mode' tool and
the legacy 'Makefile' and 'make.bat' templates. There's room for more
dramatic simplification of the former, but this will come later.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-11 20:57:03 +00:00
Antoine Beaupré
90f7c7ef3f
add link to manpages in HTML builder 
It is useful to have the HTML documentation builder actually link to
real rendered versions of HTML manpages in its output. That way people
can click on manpages to get the full documentation. There are a few
services offering this online, so we do not explicitly enable one by
default, but the Debian manpages repository has a lot of the manpages
pre-rendered, so it is used as an example in the documentation.

The parsing work is done by a transformer class that parses manpage
objects and extract name/section elements. Those then can be used by
writers to cross-reference to actual sites. An implementation is done
in the two HTML writers, but could also apply to ePUB/PDF writers as
well in the future.

This is not enabled by default: the `manpages_url` configuration item
needs to be enabled to point to the chosen site. The `page`, `section`
and `path` parameters are expanded through Python string formatting in
the URL on output.

Unit tests are fairly limited, but should cover most common use-cases.
 2018-01-11 13:20:34 -05:00