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,226 Commits 2 Branches 219 Tags
68630e68b9249c96301242a6b5b23cfd827d1514
Commit Graph

69 Commits

Author SHA1 Message Date
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
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
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
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
Stephen Finucane
d1972ac5b5 doc: Add "markdown" section to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-04-30 21:36:44 +01:00
Stephen Finucane
7a8d1dc08c doc: Fix line length 
Keep things in the fixed docs under 80 characters.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-04-30 21:36:44 +01:00
Takeshi KOMIYA
8e6c04c630 Merge branch 'master' into deprecate_highlightlang_directive 2018-04-29 21:13:13 +09:00
Takeshi KOMIYA
622119a9d4 Fix #789: `:samp:` role supports to escape curly braces with backslash 2018-04-28 12:56:01 +09:00
Jon Dufresne
365c93f227 Update all pypi.python.org URLs to pypi.org 
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
 2018-04-18 19:51:48 -07:00
Takeshi KOMIYA
b35198d847 Deprecate highlightlang directive 
highlightlang directive is not documented, and marked as old in v0.2.
 2018-04-15 00:33:02 +09:00
Gussie Carther
390ea6d35a Fix #4420: Docs conflict on use of rst_prolog and rst_epilog 2018-04-14 17:51:06 +09:00