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
12,602 Commits 2 Branches 219 Tags
2efc1065c0dcd49e10973cc47cd1b569accd3b21
Commit Graph

2342 Commits

Author SHA1 Message Date
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
Timotheus Kampik
d14e950881 #5216 update Markdown config doc to API changes 2018-07-28 18:02:32 +02:00
Takeshi KOMIYA
e045dacc84 doc: Move description for math confval, directives and roles to usage 2018-07-28 18:43:02 +09:00
Takeshi KOMIYA
dd65d00f29 Implement math_renderer framework 2018-07-28 18:20:11 +09:00
Takeshi KOMIYA
9bb1e83668 Merge branch 'master' into refactor_highlighter 2018-07-24 01:11:57 +09:00
Takeshi KOMIYA
e3483e9b04 Closes #4614: sphinx-build: Add :option:--keep-going option to show all warnings 2018-07-23 00:38:47 +09:00
Takeshi KOMIYA
ec8e06bad7 Merge pull request #5202 from tk0miya/4500_collapsiblesidebar_works_with_stickysidebar 
doc: collapsiblesidebar works well with stickysidebar
 2018-07-22 21:12:58 +09:00
Takeshi KOMIYA
d0900001af doc: collapsiblesidebar works well with stickysidebar 2018-07-22 00:09:11 +09:00
Takeshi KOMIYA
a3189b460c Merge pull request #5136 from TimKam/4255-clarify-startdocname-config-param 
#4255 clarify documentation of ``startdocname`` parameters.
 2018-07-21 16:31:48 +09:00
Takeshi KOMIYA
f3019ee197 Apply :confval:trim_doctest_flags to all builders (cf. text, manpages) 2018-07-21 13:54:51 +09:00
Takeshi KOMIYA
4f296c5e67 Refactor: Run highlightlang on resolving phase 2018-07-21 13:54:09 +09:00
Takeshi KOMIYA
0c277f3ff0 `sphinx.highlighting.PygmentsBridge.unhighlight()` is deprecated 2018-07-21 01:50:23 +09:00
Timotheus Kampik
395d60d49e #4255 improve conciseness 2018-07-19 21:10:16 +02:00
Takeshi KOMIYA
a7ea9d7c5b Merge pull request #5185 from TimKam/4886-linkcheck-ignore-doc 
4886 correct link check ignore doc
 2018-07-19 23:52:29 +09:00
Timotheus Kampik
8066d36e3c #4886 clarify example/note 2018-07-18 19:40:22 +02:00
Takeshi KOMIYA
f72a53f5bd Update docs for #5122 (nitpicky option) 2018-07-19 01:22:20 +09:00
Timotheus Kampik
f605012617 #4886 remove obsolete * 2018-07-17 20:40:49 +02:00
Timotheus Kampik
6bbfc3bba9 #1618 remove obsolete warning from doc 
Setting `html_copy_source` no longer affects search results
 2018-07-17 19:59:29 +02:00
Takeshi KOMIYA
d96574d72d Merge pull request #5188 from mgeier/patch-1 
DOC: Fix typo: add_source_parsers() -> add_source_parser()
 2018-07-17 23:23:44 +09:00
jfbu
e584b8e1db Update LaTeX docs 2018-07-17 15:45:30 +02:00
Matthias Geier
e1772bafda DOC: Fix typo: add_source_parsers() -> add_source_parser() 2018-07-17 10:00:05 +02:00