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,798 Commits 2 Branches 219 Tags 163 MiB
7c712464bb
Commit Graph

176 Commits

Author SHA1 Message Date
jfbu
1920d1d950 LaTeX: `\sphinxmaketitle and optional \sphinxbackoftitlepage` 
Closes: #5849
 2018-12-21 21:38:27 +01:00
Jean-François B
696c8f0fc0
Merge pull request #5693 from jfbu/latex_doc_unicode_in_math 
LaTeX (doc): explain how to allow Unicode input in math
 2018-12-20 20:31:31 +01:00
jfbu
fdb6147555 LaTeX (doc): explain how to allow Unicode input in math 
Closes: #5249
 2018-12-20 19:43:50 +01:00
Takeshi KOMIYA
a1976cc0c8 Update docs 2018-12-19 01:32:26 +09:00
Jon Dufresne
bade33c7e4 Remove unnecessary encoding cookie from Python source files 
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
 2018-12-16 12:22:12 -08:00
jfbu
7364e0c2fd Update docs for LuaLaTeX 2018-12-15 15:16:43 +01:00
Jean-François B
661fb1de59
LaTeX: use Bjarne option of fncychap also if language is set to 'en' (#5776) 
Closes: #5772
 2018-12-15 11:37:56 +01:00
jfbu
022fc9d3b6 LaTeX: use `\small` fontsize in code-blocks with xelatex and lualatex 2018-12-13 15:00:38 +01:00
Takeshi KOMIYA
e527be396a
Merge pull request #5607 from tk0miya/smart_texinfo_conf_py 
quickstart: Simplify generated conf.py (for texinfo)
 2018-12-02 01:30:51 +09:00
Jean-François B
8412bdf9d6
Merge pull request #5645 from jfbu/latex_greek_cyrillic_letters 
LaTeX: support for Greek and Cyrillic
 2018-11-21 23:11:15 +01:00
jfbu
1edf2a45b9 LaTeX: font choices for Greek and Cyrillic support, and (Xe|Lua)LaTeX 2018-11-21 22:21:02 +01:00
jfbu
6283324b1a Load CMU by filename, not font name, for XeLaTeX 2018-11-17 01:46:18 +01:00
jfbu
2825e338c2 LaTeX: support for Greek and Cyrillic 
0. do not escape Unicode Greek letters via LaTeX math mark-up: pass them
   through un-modified to LaTeX document,

1. if "fontenc" receives extra option LGR, then pdflatex will support
   Unicode Greek letters (not in math), and with extra option T2A it
   will support (most) Unicode Cyrillic letters.

2. for pdflatex with LGR, this will use "textalpha" LaTeX package and
   "substitutefont" package to set up some automatic font substitution
   to work around the unavailability of Greek with "times"
   package (which is default font package chosen by Sphinx for
   pdflatex), same with T2A and "substitutefont" for Cyrillic.

3. for xelatex/lualatex, set up Computer Modern Unicode as default font,
   as it supports Cyrillic and Greek scripts,

4. for platex, don't do anything special as the engine already has
   its default font supporting Cyrillic and Greek (even in math mode!)

Closes: #5251
Fixes:  #5248
Fixes:  #5247
 2018-11-16 21:14:51 +01:00
Stephen Finucane
1c07f0004f doc: Add "theming" to usage guide 
This one is a little unusual. The current theming doc mixes user-focused
documentation with developer-focused documentation. This is confusing
and unnecessary. Resolve the issue by splitting the doc in two. The
user-focused docs are moved to the advanced section of the usage guide,
while the developer docs remain where they are, pending the addition of
a developer guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 15:23:33 +01:00
Stephen Finucane
71e8477597 doc: Add "websupport" to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 13:23:06 +01:00
Stephen Finucane
23afd29cbb doc: Add "setuptools" to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 13:22:38 +01:00
Stephen Finucane
d380617c3b doc: Add "internationalization" to the usage guide 
This is added to the new "advanced" subsection.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 13:20:46 +01:00
Takeshi KOMIYA
aeadcdd0b6 doc: Reorder section 2018-11-11 21:57:14 +09:00
Takeshi KOMIYA
00254ea256
Merge pull request #5556 from drewrisinger/drewrisinger-typo-1 
[Bug]: Typo in Domains.rst
 2018-10-25 22:23:26 +09:00
Takeshi KOMIYA
83c50837c1
Merge pull request #5564 from nomis/rst-typo 
doc: Fix typo of "restructuredtext"
 2018-10-25 22:07:00 +09:00
Drew
dc35335a35
[bug]: Correct RST header 
Have correct amount of "~" for RST heading.
 2018-10-24 16:28:11 -04:00
Simon Arlott
7aa750a637
doc: Fix typo of "restructuredtext" 2018-10-24 19:52:42 +01:00
Simon Arlott
f5d4e4207d
doc: Fix typo of "default" 2018-10-24 19:52:24 +01:00
Eric N. Vander Weele
9fcef5030a autodoc: Respect member-order in autodoc_default_options as documented 
In the `autodoc_default_options` documentation, it mentions that
`member-order` is respected; however, when setting the key-value pair in
`conf.py`, it is not.  Thus, add `member-order` as one of the default
options respected in `conf.py`.  Additionally, update the list of
supported options to match the example.
 2018-10-16 10:21:18 -07:00
Drew
3812d06544
Update domains.rst 2018-10-10 15:56:29 -04:00
Takeshi KOMIYA
973c3ffa25
Merge branch 'master' into change_master_doc_to_index 2018-09-29 21:12:40 +09:00
Takeshi KOMIYA
ff8df59ac1
Merge pull request #5479 from jdufresne/https 
Prefer https:// links where available
 2018-09-24 09:04:54 +09:00
Jon Dufresne
dd383ec472 Prefer https:// links where available 2018-09-23 11:50:42 -07:00
Jon Dufresne
d9283a40d8 Correct installation docs about supported Python versions 
Since commit 9412bd76b7, older Python
versions have been dropped.
 2018-09-23 08:44:29 -07:00
Rob Ruana
e547a6a0d2
Fixes #5426: [Napoleon] Better handling of inline attributes (#5470) 
* Fixes #5426: [Napoleon] Better handling of inline attributes

* Removes uneeded NOQA comments

* Fixes imports
 2018-09-23 09:26:17 -04:00
Jon Dufresne
490e4aed41 Remove unnecessary object from class definitions 
In Python 3, all classes are new-style classes. The object in the
definition is redundant and unnecessary.
 2018-09-11 07:07:01 -07:00
Takeshi KOMIYA
07fd1c0680 Fix #4018: htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix 2018-09-08 23:11:14 +09:00
Takeshi KOMIYA
342de4f0fd Merge branch '1.8' 2018-09-05 23:10:20 +09:00
Takeshi KOMIYA
79de756423
Merge pull request #5342 from tk0miya/drop_py2_support 
Update requirements and dependencies for Sphinx-2.0
 2018-09-05 22:55:07 +09:00
Takeshi KOMIYA
abcb5bd5ec The default setting for master_doc is changed to 'index' 2018-09-04 01:14:16 +09:00
TAKEDA-Takashi
683cccac4d docs: Fix wrong name of MecabSplitter 2018-09-03 16:18:24 +09:00
Takeshi KOMIYA
daac35cda7 doc: Add versionadded label (refs: #5029) 2018-09-03 10:46:38 +09:00
Timotheus Kampik
1a801524c6 Merge branch 'master' into 1618-make-search-results-reader-friendly 2018-08-29 19:01:13 +02:00
Takeshi KOMIYA
deca8047ae LaTeX builder now depends on TeX Live 2015 or above 2018-08-30 01:03:57 +09:00
Timotheus Kampik
26bd565dee Merge branch 'master' into 1618-make-search-results-reader-friendly 2018-08-27 21:34:43 +02:00
Takeshi KOMIYA
8c4de32c7d Fix #4182: autodoc: Support :confval:suppress_warnings 2018-08-26 23:29:00 +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
8e56f86383 Add :rst:role:math:numref role to refer equations (Same as :rst:role:eq) 2018-08-02 01:52:40 +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
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
da7a06b323 WIP: #726, #969: Add mathjax_config 2018-07-29 22:36:53 +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
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
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
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
Timotheus Kampik
537a69e518 #4886 adjust documentation to match actual link check behavior 2018-07-16 23:22:26 +02:00
Jean-François B
54456ba455
Merge branch 'master' into 3742_index_in_PDF_bookmark_at_RTD 2018-07-16 17:15:45 +02:00
Jean-François B
6c12dba968
Merge pull request #5134 from jfbu/latex_xindy 
Add new config value ``latex_use_xindy``
 2018-07-16 10:17:06 +02:00
jfbu
9b2aac68ea LaTeX: extend to all projects the #3742 fix for PDF builds at RTD 
Refs: https://github.com/rtfd/readthedocs.org/issues/2857
 2018-07-15 15:24:25 +02:00
jfbu
60b160431a LaTeX: add hyperref support to general index as handled by xindy 
- achieve hyperlinked page numbers in general index, despite xindy's
  incompatibility with hyperref,

- obtain compatibility of pdflatex with xindy for documents with
  Cyrillic scripts,

- use xindy by default with xelatex/lualatex because any non-ascii
  character as first letter of an indexed term breaks PDF build if using
  makeindex with lualatex, and produces incoherent index with xelatex.

This commit also switches off xindy logs (which were activated in parent
commits) as they are voluminous and not of immediate use to Sphinx user.
 2018-07-14 19:13:59 +02:00
Dan Abdinoor
83c9380299
Fix links to sphinx-build man page 
Swap``program`` for ``doc`` links to sphinx-build man page.
 2018-07-10 12:14:45 -04:00
Timotheus Kampik
94b467dbc8 #4255 clarify documentation of `startdocname` parameters. 
* Relative path from source directory

* Similar to ``master_doc`` in functionality
 2018-07-01 16:10:51 +02:00
jfbu
90c2b528b1 Update docs and CHANGES for `latex_use_xindy` config variable 2018-06-30 23:37:26 +02:00
Takeshi KOMIYA
1140e81df7 Merge remote-tracking branch 'stephenfin/doc-rework' 2018-06-26 01:05:19 +09:00
Daniel Hahler
8f94429a21 doc: fix func/meth references to Sphinx 2018-06-25 08:25:56 +02:00
Stephen Finucane
d9ccc95717 doc: Add "extensions" to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-06-20 09:30:47 +01:00
Stephen Finucane
b595c4a45b doc: Add "builders" to usage guide 
This is placed in a directory as this document will eventually be split
up. However, this is not the day to do this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-06-20 09:26:59 +01:00
Jon Dufresne
2f17a0e8c8 Update Python 2 doc links to Python 3 
Python 3 docs are more actively maintained and are the future.
 2018-06-09 20:59:43 -07:00
Jakob Lykke Andersen
cc026946f7 C++, add support for anon entities. 
Anonymous entities are specified with names starting with "@",
but are rendered as "[anonymous]".

Fixes sphinx-doc/sphinx#3593 and sphinx-doc/sphinx#2683.
 2018-06-09 12:24:34 +02:00
Takeshi KOMIYA
fc7817b854
Merge pull request #5034 from tk0miya/add_html_js_files 
Add :confval:`html_js_files`
 2018-06-09 11:51:11 +09:00
Jean-François B
95a8099913
Merge branch 'master' into latex_remove_shorthandoff_variable 2018-06-08 19:53:46 +02:00
Takeshi KOMIYA
9fc2657d7e Add :confval:html_js_files 2018-06-09 02:38:36 +09:00
jfbu
359854fa78 Postpone to 3.0 removal of ExtBabel.get_shorthandoff() 2018-06-07 18:29:24 +02:00
jfbu
b41b1dac5c Deprecate sphinx.writers.latex.ExtBabel.get_shorthandoff() 
This partially reverts d17f3955a5
 2018-06-06 19:16:14 +02:00
Takeshi KOMIYA
e30b10a57d html: Output `canonical_url metadata if :confval:html_baseurl` set 2018-06-06 21:18:17 +09:00
jfbu
a32c358342 Remove usage of internal shorthandoff variable from LaTeX writer 2018-06-05 18:38:59 +02:00
Jakob Lykke Andersen
6d52b63eee C++, support for unions. 2018-05-26 20:03:25 +02:00
Jakob Lykke Andersen
f592483156 Add cpp:texpr role (style alternative to cpp:expr) 
Simplified version of sphinx-doc/sphinx#4836,
thanks to mickk-on-cpp.
 2018-05-26 17:25:41 +02:00
Daniel M. Capella
d2b0098045
doc: Fix minor typo "like" -> "link" 2018-05-13 04:15:11 +00:00
Takeshi KOMIYA
5a90e0bc85 Update docs (refs: #4875) 2018-05-03 17:40:32 +09:00
Takeshi KOMIYA
cbf4ee24f9 Fix #4811: The files under html_static_path are excluded from source 2018-05-03 11:07:14 +09:00
Takeshi KOMIYA
0ea06e40ca
Merge branch 'master' into 789_escape_braces_on_samp_role 2018-05-03 01:32:35 +09:00
Stephen Finucane
0bf8886fc4 doc: Address review comments 
These came up in the review for pull request #4799.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-04-30 21:41:12 +01:00
Stephen Finucane
16e76faba3 doc: Add "config" to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-04-30 21:36:45 +01:00