jfbu
5e86c1c934
Fix #4090 : extra LaTeX macros via `latex_additional_files`
2017-10-22 13:24:03 +02:00
jfbu
90e3425ed7
Fix #4149 : Documentation: Help choosing latex_engine
2017-10-22 11:45:28 +02:00
jfbu
5dbfc43dda
Make clearer that Sphinx applies Smart quotes by default
...
modified: doc/config.rst
2017-10-19 10:00:08 +02:00
jfbu
6a897af1d9
Clarify docs about `html_use_smartypants` deprecation
2017-10-19 09:56:14 +02:00
jfbu
77c5aaaa97
Fix #4134 : [doc] docutils.conf is not documented explicitly
2017-10-19 09:23:41 +02:00
Takuya Noguchi
0e82661b63
#4068 : Update linkcheck docs to use requests
2017-09-18 23:57:08 +09:00
Jakob Lykke Andersen
c43c781a03
Docs, add missing `member` role for C domain
...
Fixes sphinx-doc/sphinx#4038
2017-09-07 21:26:36 +02:00
Atlas
16cbf658a2
Update tutorial.rst
2017-08-23 11:56:35 +02:00
Takeshi KOMIYA
246143dc3a
Merge pull request #3931 from tk0miya/3926_autodoc_warningiserror
...
Fix #3926 : Add ``autodoc_warningiserror`` to suppress the behavior of ``-W`` option
2017-07-16 14:06:38 +09:00
Takeshi KOMIYA
1869f4d674
Update docs (refs: #3923 )
2017-07-16 01:48:09 +09:00
Takeshi KOMIYA
bfd71cd77b
Fix #3926 : Add `autodoc_warningiserror to suppress the behavior of -W` option
2017-07-15 22:04:56 +09:00
Yoshiki Shibukawa
f0766ce4cd
fix #3840 : epub_uid should be XML Name
2017-06-30 23:37:32 +09:00
jfbu
adc056200c
Improve access to table and math markup info in docs
2017-06-20 15:57:32 +02:00
jfbu
6f283d6879
Update docs regarding the CDN used by default for MathJax
2017-06-20 00:20:22 +02:00
jfbu
521158549a
Fix docs ( Close : #3863 )
2017-06-17 15:45:40 +02:00
jfbu
c2277ae61c
latex: hint that code-blocks continue on next page ( closes #3764 )
2017-06-14 09:49:39 +02:00
Takeshi KOMIYA
9f1fca055f
Merge pull request #3853 from brechtm/docs_rinohtype
...
Docs: mention rinohtype as an alternative PDF builder
2017-06-11 17:01:14 +09:00
jfbu
db8ff5fb75
Fix markup typo and missing bit in docs
2017-06-05 19:43:09 +02:00
jfbu
8b35c36cfe
Shorten a definition list in latex docs
2017-06-05 16:55:37 +02:00
jfbu
bd8c7e1410
Make the latex docs more concise
2017-06-05 15:34:23 +02:00
Brecht Machiels
4749157bd3
Docs: mention rinohtype as an alternative PDF builder
2017-06-05 14:51:35 +02:00
Sanjeev Gupta
a561fdb8c1
Expand and update list of extensions
...
Updated from https://bitbucket.org/birkenfeld/sphinx-contrib/
2017-06-02 04:11:48 +08:00
Sanjeev Gupta
a259df7dea
Proof read and polish english. Some typos.
2017-06-02 00:22:33 +08:00
Sanjeev Gupta
97f2f16582
Proofread, polish some english, and convert to HTTPS
...
All links checked, if HTTPS leads to the same page, then
convert. A couple of typos as well.
2017-06-01 22:50:16 +08:00
Sanjeev Gupta
cc69691032
Minor typo
2017-06-01 12:37:33 +08:00
Sanjeev Gupta
1a62b629c5
Test URLs and convert to HTTPS where possible
2017-05-31 22:07:01 +08:00
jfbu
075a8cfb8f
Closes #3829 : add `html_sidebars` default to sphinx-quickstart
2017-05-30 13:10:11 +02:00
jfbu
8679e145e4
Update docs and CHANGES about Latexmk not being used on Windows
2017-05-28 16:24:21 +02:00
jfbu
350f58a618
Update CHANGES and docs regarding Latexmk dependency
2017-05-28 09:43:24 +02:00
jfbu
b18a3f82b4
Fix flake8
2017-05-20 10:16:24 +02:00
jfbu
6422f7b8c9
Fix #3742 : missing `Index` bookmark and TOC entry in PDF builds at RTD
...
The trick is to create an Index TOC/bookmarks entry in anticipation of
makeindex execution, as RTD (currently) does only one pdflatex run after
makeindex.
https://github.com/rtfd/readthedocs.org/issues/2857
The workaround works for Sphinx own docs, which uses ``'manual'``
docclass and puts the general index at very end of document.
2017-05-20 09:54:09 +02:00
jfbu
ae1455077b
Fix #3746 : PDF builds fail with latexmk version 4.48 or earlier
...
This is tested to work with latexmk version: 4.39 (10 Nov 2013).
For xelatex engine and with latexmk 4.52b or later (Jan 2017), setting
LATEXMKOPTS Makefile variable on command line to "-xelatex" results in
faster builds, because PDF is produced only on last run.
2017-05-13 13:05:58 +02:00
jfbu
773659c41a
Mention latex table templates in docs
2017-05-11 22:50:58 +02:00
jfbu
ad7d2bd548
Fix typo
2017-05-11 10:25:49 +02:00
jfbu
e20f28ce70
Improve latex docs of `latex_use_latex_multicolumn` config setting
2017-05-11 10:24:10 +02:00
jfbu
97625a2c5c
Don't use forced mode for Latexmk
2017-05-08 20:53:03 +02:00
jfbu
38e6dfca34
Update latex docs
2017-05-07 11:10:41 +02:00
Takeshi KOMIYA
8f0d269069
Merge branch '1.6-release' into 3633_misdetect_unreferenced_citations
2017-05-07 16:14:50 +09:00
Takeshi KOMIYA
6d2bcf9c27
Mark as experimental
2017-05-07 16:13:19 +09:00
jfbu
79412051d2
Merge branch 'stable' into 1.6-release
2017-05-05 13:33:50 +02:00
jfbu
321a5e7a5e
Fix #3702 : abstract LaTeX styling of figure legends into sphinxlegend
2017-05-04 09:59:29 +02:00
jfbu
ca543eee23
Separate latexmk and pdflatex options for better control
2017-05-03 10:59:12 +02:00
jfbu
af76149a2b
Fix style-check whitespace error in doc
2017-05-03 07:52:32 +02:00
jfbu
7bbc8c1f88
By default, `make latexpdf` will try to ignore LaTeX errors
...
For example, if a graphics file is missing. The error is still reported
but some functional PDF may still have been produced. Some projects have
temporary errors with LaTeX (missing Unicode characters, graphics file
using wrong formats, ...) affecting some small percentage of the
documentation, and it may be important to make at least some PDF
available, postponing complete resolution of LaTeX problems to a later
date.
2017-05-03 00:30:33 +02:00
Takeshi KOMIYA
d1e8e41b5e
Fix #3633 : misdetect unreferenced citations
2017-04-29 23:22:00 +09:00
Takeshi KOMIYA
721c3d5fae
Merge branch 'stable' into 1.6-release
2017-04-29 15:11:55 +09:00
Takeshi KOMIYA
bd66ffc1fa
Fix the unreleased version number is shown (refs: #3678 , #3027 )
2017-04-28 01:19:01 +09:00
Takeshi KOMIYA
8462d4bcda
doc: Update
2017-04-27 21:24:33 +09:00
Dmitry Shachnev
9236beb9ee
Deprecate the html_use_smartypants option
2017-04-25 14:17:30 +03:00
Takeshi KOMIYA
c50321d3ca
Merge branch 'master' into drop_websupport
2017-04-23 19:18:01 +09:00
