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
11,626 Commits 2 Branches 219 Tags 163 MiB
38c5ec13a5
Commit Graph

2159 Commits

Author SHA1 Message Date
jfbu
1e07cb10fc Fix various spelling typos 2018-12-27 13:06:33 +01:00
jfbu
1920d1d950 LaTeX: `\sphinxmaketitle and optional \sphinxbackoftitlepage` 
Closes: #5849
 2018-12-21 21:38:27 +01:00
Matthias Geier
4af446349c DOC: Fix some minor mistakes in "LaTeX customization" 2018-12-11 18:20:28 +01:00
Takeshi KOMIYA
68e0210746 doc: Add deprecation info to script_files (template variable) 2018-11-21 20:15:47 +09:00
Dmitry Shachnev
2a9cad7b2e Move language-specific data into a new JS file, language_data.js 
This file is included in script_files, so it will be present even for
projects using custom templates.

Fixes #5460.
 2018-11-04 12:13:07 +03:00
jfbu
6f08c09ecb Improve Table of Deprecated APIs for LaTeX output (docs) 2018-09-22 11:44:04 +02:00
Takeshi KOMIYA
ae12f357c7 Fix #5463: mathbase: math_role and MathDirective was disappeared in 1.8.0 2018-09-21 23:44:11 +09:00
Takeshi KOMIYA
b2b833d39e Update CHANGES for PR #5403 2018-09-10 20:45:16 +09:00
Takeshi KOMIYA
8e729b419e Fix #5399: Sphinx crashes if unknown po file exists 2018-09-08 22:21:59 +09:00
Takeshi KOMIYA
86abb57577 Fix #5362: apidoc: Add `--toc` option to change the filename of ToC 2018-09-06 18:29:44 +09:00
Takeshi KOMIYA
daac35cda7 doc: Add versionadded label (refs: #5029) 2018-09-03 10:46:38 +09:00
Takeshi KOMIYA
864ded3d8a
Merge pull request #5343 from tk0miya/5340_update_docs 
docs: Fix wrong descriptions for logging APIs
 2018-08-26 11:30:51 +09:00
Takeshi KOMIYA
0a485740a8 docs: Fix wrong descriptions for logging APIs 2018-08-25 10:59:04 +09:00
Takeshi KOMIYA
328ff6eeae Fix i18n: warnings for translation catalogs have wrong line numbers 2018-08-22 21:01:50 +09:00
Takeshi KOMIYA
472001eeb7 Fix typo 2018-08-22 11:08:33 +09:00
Takeshi KOMIYA
e3f383ad7c
Merge pull request #5315 from tk0miya/add_autodoc_default_options 
Add autodoc_default_options
 2018-08-20 00:26:08 +09:00
Takeshi KOMIYA
17874a1a4b
Merge pull request #5297 from AWhetter/viewcode_follow_imported_event 
Plugins can resolve imported members for viewcode
 2018-08-19 23:45:09 +09:00
Takeshi KOMIYA
3d9e2cf831 Add autodoc_default_options 2018-08-18 18:22:16 +09:00
Jakob Lykke Andersen
1c035d7203 C++, add support for overload-specific references. 
The "any" and "func" roles now accepts full function declarations.

Fixes #1552
 2018-08-18 08:27:23 +02:00
Lewis Haley
f196a92055 autodoc: add 'exclude-members' to user global options 
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__
 2018-08-17 16:02:11 +01:00
Lewis Haley
6e1e35c98a autodoc: allow specifying values to global arguments 
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.
 2018-08-17 15:51:00 +01:00
Takeshi KOMIYA
28131df93e
Merge pull request #5307 from akaihola/5273_doctest_conditional_skip 
Feature: skip doctests conditionally
 2018-08-17 00:33:29 +09:00
Antti Kaihola
43d5810083 Ref #5273: doctest: add documentation for the :skipif: option 2018-08-16 14:01:57 +03:00
Ashley Whetter
97164faec3 Plugins can resolve imported members for viewcode 2018-08-13 17:07:50 -07:00
Takeshi KOMIYA
f670a33f5b Fix #5246: Add :confval:singlehtml_sidebars to configure sidebars for singlehtml 2018-08-13 11:04:45 +09:00
Jakob Lykke Andersen
4397606d03 C++, fix direct lookup problem 
Also clarify documentation regarding cross-references involving templates.

See also sphinx-doc/sphinx#2057
 2018-08-11 11:04:56 +02:00
Takeshi KOMIYA
206395121d
Merge pull request #5250 from tk0miya/refactor_math4 
Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`)
 2018-08-04 21:03:49 +09:00
Takeshi KOMIYA
68630e68b9 Merge branch '1.7' 2018-08-04 20:34:42 +09:00
Takeshi KOMIYA
ec7ee91dd3
Merge pull request #5230 from tk0miya/726_mathjax_config 
#726, #969: Add mathjax_config
 2018-08-04 19:21:01 +09:00
Takeshi KOMIYA
c216c53a26
Merge pull request #5227 from tk0miya/changeset_domain 
refactor: Move repository of changesets to domain from env
 2018-08-04 18:43:47 +09:00
jfbu
8a23ad1f44 Update LaTeX docs for a 1.7.6 change (refs #5178) 2018-08-02 12:46:33 +02:00
jfbu
5a220d648a Fix LaTeX docs of Latin Modern font with XeLaTeX/LuaLaTeX 
refs: #5251
 2018-08-02 10:06:31 +02:00
Takeshi KOMIYA
8e56f86383 Add :rst:role:math:numref role to refer equations (Same as :rst:role:eq) 2018-08-02 01:52:40 +09:00
Takeshi KOMIYA
03d083e784 Move VersionChanges directive to sphinx.domains.changeset 2018-08-02 01:51:51 +09:00
Takeshi KOMIYA
25bfa1692a refactor: Move repository of changesets to domain from env 2018-08-02 01:51:50 +09:00
Jean-François B
5edcb2850c
Merge pull request #5239 from jfbu/latex_revert_5181_RTDbug_workaround 
Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD"
 2018-07-31 19:04:21 +02:00
jfbu
077e9afd29 LaTeX: fix usage of PAPER envvar, which got broken at Sphinx 1.5 
Fix: #5234
 2018-07-31 17:37:04 +02:00
jfbu
d07103fde2 Fix typo in updated docs 2018-07-31 17:11:59 +02:00
jfbu
b8f43e56ae Update latex docs 2018-07-31 16:54:25 +02:00
jfbu
f0067f4a04 Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD" 
This reverts commit 9b2aac68ea.
 2018-07-31 10:46:48 +02:00
jfbu
9a0097bef2 Update LaTeX xindy docs 2018-07-30 19:52:12 +02:00
Takeshi KOMIYA
609ec5ef33
Merge branch 'master' into 4614_keep_going 2018-07-31 01:11:08 +09:00
Takeshi KOMIYA
5fd62810b9
Merge pull request #5229 from tk0miya/refactor_latex2 
Check latex_elements at config-inited event
 2018-07-30 23:16:02 +09:00
Takeshi KOMIYA
5520969b39
Merge pull request #5228 from tk0miya/move_make_mode_to_sphinx.cmd 
Move make mode to sphinx.cmd
 2018-07-30 23:11:26 +09:00
Takeshi KOMIYA
90246b82b5 Check latex_elements at config-inited event 2018-07-29 22:43:13 +09:00
Takeshi KOMIYA
da7a06b323 WIP: #726, #969: Add mathjax_config 2018-07-29 22:36:53 +09:00
Takeshi KOMIYA
c8a66b73cf Update CHANGES 2018-07-29 22:24:56 +09:00
Takeshi KOMIYA
7218fe9dca Deprecate whole of sphinx.ext.mathbase 2018-07-29 12:32:46 +09:00
Takeshi KOMIYA
104bd42f51
Merge branch 'master' into refactor_highlighter 2018-07-29 11:21:36 +09:00
Takeshi KOMIYA
e045dacc84 doc: Move description for math confval, directives and roles to usage 2018-07-28 18:43:02 +09:00