Commit Graph

1715 Commits

Author SHA1 Message Date
Stephen Finucane
c244a7c9a9 doc: Update sphinx-apidoc man page
This man page wasn't making full use of Sphinx's own features. Update it
to do so, and remove the duplicated information from 'invocation'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 15:59:32 +01:00
Takeshi KOMIYA
662d8deaf7 Merge pull request #3904 from TimKam/2307-fix-markup-glitch-lineno-start-doc
#2307 add `::` to show markup sample, not evaluate it
2017-07-02 21:54:31 +09:00
Takeshi KOMIYA
007593fa81 Merge branch 'stable' 2017-07-02 20:28:50 +09:00
Timotheus Kampik
16a2367301 #2307 add :: to show markup sample, not evaluate it 2017-07-02 13:24:38 +02:00
Yoshiki Shibukawa
f0766ce4cd fix #3840: epub_uid should be XML Name 2017-06-30 23:37:32 +09:00
Takeshi KOMIYA
e57fb74ee5 Merge branch 'stable' 2017-06-25 01:48:23 +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
3d5e0c5d7c Merge branch 'stable' 2017-06-17 10:37:30 +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
f6d0b07704 Merge branch 'stable' 2017-06-13 00:32:39 +09: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
5e2d4ca77b Merge branch 'stable' 2017-06-05 15:40:18 +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
jfbu
d4f37925c0 Merge branch 'stable' 2017-06-03 17:36:19 +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
Takeshi KOMIYA
b145011c1b Merge branch 'stable' 2017-05-29 00:33:13 +09:00
jfbu
8679e145e4 Update docs and CHANGES about Latexmk not being used on Windows 2017-05-28 16:24:21 +02:00
jfbu
d042b6d1cb Merge branch 'stable' 2017-05-28 10:02:39 +02:00
jfbu
350f58a618 Update CHANGES and docs regarding Latexmk dependency 2017-05-28 09:43:24 +02:00
Takeshi KOMIYA
ca6a1edd2f Merge branch 'stable' 2017-05-26 00:15:00 +09: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
Takeshi KOMIYA
4435d4fb26 Merge branch '1.6-release' 2017-05-15 00:20:09 +09: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
Takeshi KOMIYA
78a20617b5 Merge branch '1.6-release' 2017-05-13 15:42:28 +09:00
jfbu
773659c41a Mention latex table templates in docs 2017-05-11 22:50:58 +02:00
jfbu
e277cb7285 Merge branch '1.6-release'
Fixed conflicts:
	tests/test_build_html5.py

Also updated tests/test_build_latex.py
2017-05-11 11:45:14 +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
f7876f6b74 Update latex docs 2017-05-07 11:12:18 +02:00
jfbu
a700f4631f Merge branch '1.6-release' 2017-05-07 11:11:02 +02:00
jfbu
38e6dfca34 Update latex docs 2017-05-07 11:10:41 +02:00
jfbu
5ca651f220 Merge branch '1.6-release' 2017-05-07 10:49:45 +02:00
Takeshi KOMIYA
af02bfa7b3 Merge branch 'master' into 3638_eqref_format 2017-05-07 16:20:51 +09: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
f547e59a7a Merge branch '1.6-release' 2017-05-05 13:34:47 +02: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