Commit Graph

118 Commits

Author SHA1 Message Date
Takeshi KOMIYA
9f5c676322 Use flake8-import-order 2018-01-28 01:52:16 +09:00
Takeshi KOMIYA
f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Stephen Finucane
65a81e2056 doc: Add sphinx-autogen man page
This wasn't documented in depth anywhere, so do just that.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-07-11 16:08:40 +01:00
Yoshiki Shibukawa
f0766ce4cd fix #3840: epub_uid should be XML Name 2017-06-30 23:37:32 +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
bd66ffc1fa Fix the unreleased version number is shown (refs: #3678, #3027) 2017-04-28 01:19:01 +09:00
Takeshi KOMIYA
c57e47e042 Year++ 2017-03-26 11:49:34 +09:00
jfbu
89431bf833 Fix accidental use of `language='ja'` in docs (at 41bb388) 2017-03-23 11:03:38 +01:00
jfbu
41bb38877f Update docs (domains.rst) 2017-03-21 08:24:35 +01:00
jfbu
c240a90f18 improve the index appearance in Sphinx's own PDF documentation 2017-02-05 23:20:30 +01:00
jfbu
a48a9c883a style the latex chapter in the docs (for pdf output) 2016-10-29 16:30:33 +02:00
Takeshi KOMIYA
ec934d476a Fix #2983: Rename `epub3_description and epub3_contributor to epub_description and epub_contributor`. 2016-10-01 00:17:19 +09:00
Yoshiki Shibukawa
8f162a132e fix epub warning in Sphinx's document 2016-08-09 16:58:56 +09:00
Yoshiki Shibukawa
06a861703d Reduce epub checker warnings/errors for epub3 builder.
Fix DOCTYPE to html5 and change extension from .html to .xhtml.

Sphinx's documents result:

  before: 95 warnings& 1238 errors
  after: 623 errors
2016-07-17 09:53:04 +09:00
Georg Brandl
46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Georg Brandl
548a6dc22e final pep8 fixes; reactivate most warnings in flake8 2015-03-08 17:15:54 +01:00
shimizukawa
b0d40ea22c Closes #1735: Use https://doc.python.org/ instead of `http protocol. It was used for sphinx.ext.intersphinx` and some documentation. 2015-02-23 04:20:35 +00:00
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Takayuki Shimizukawa
5bd2143fd0 enable sphinx.ext.viewcode for sphinx doc itself 2014-10-28 13:45:27 +09:00
Georg Brandl
a973daea41 make :any: role work with intersphinx! 2014-09-19 13:31:55 +02:00
Georg Brandl
ac92719ac3 Update copyright year. 2014-03-01 08:18:23 +01:00
Georg Brandl
e030031321 Update copyright year. 2014-03-01 08:18:16 +01:00
Rob Ruana
63fbb819c7 Makes suggested changes before adding napoleon to sphinx 2014-01-19 13:43:54 -05:00
Rob Ruana
a00a096069 Merges napoleon extension into mainline sphinx 2014-01-18 13:56:23 -05:00
Roland Meister
73a1420cc6 Add epub_guide entry to doc/conf.py
The toc for the spinx documentation actually is in contents.rst.
2013-06-19 21:02:27 +02:00
Takayuki Shimizukawa
649a75c427 add 'locale_dirs' and 'gettext_compact' to conf.py for translation setup easier 2013-03-31 12:22:08 +09:00
Roland Meister
a567d77e51 epub_use_index instead of html_use_index for epub builder (Issue #1106)
The change adds the method get_builder_config.
This allows use of the option epub_use_index instead
of html_use_index for epub output.
2013-03-06 18:43:21 +01:00
Roland Meister
32414bf3d3 Add orphan documents as epub_post_files. 2013-02-14 21:34:26 +01:00
shirou
0635eddd07 add "epub_show_urls" option to doc and quickstart. 2013-02-09 23:00:47 +09:00
Georg Brandl
20279b07a4 New doc design "sphinx13". 2013-01-18 23:17:11 +01:00
Georg Brandl
151856819c Copyright update. 2013-01-01 22:13:15 +01:00
Georg Brandl
4763419db1 Update Sphinx URL to new sphinx-doc.org domain. 2012-11-04 11:28:12 +01:00
Roland Meister
024b5950dd Merge with birkenfeld/sphinx 2012-02-13 20:59:37 +01:00
Georg Brandl
ff940a16b6 Add a rudimentary manpage for sphinx-apidoc. 2011-10-07 12:27:19 +02:00
Roland Meister
5cb3823223 Add _static/websupport.js to epub_exclude_files. 2011-02-28 23:20:08 +01:00
Roland Meister
55c7fa44bb Merge with birkenfeld/sphinx. 2011-02-28 23:15:35 +01:00
Roland Meister
246d07807d Added epub_max_image_width configuration option. 2011-02-28 21:17:52 +01:00
Roland Meister
fe07254b9c Added epub_fix_images configuration option 2011-02-27 22:02:30 +01:00
Georg Brandl
5c39cfb6e9 merge with 1.0 2011-01-07 19:04:53 +01:00
Georg Brandl
210add8d2c Parse parmeter field in event descriptions. 2011-01-07 16:27:47 +01:00
Georg Brandl
92a5db16d5 #516: Added new value of the :confval:latex_show_urls option to show the URLs in footnotes. 2011-01-06 18:29:37 +01:00
Georg Brandl
17efae5622 merge with 1.0 2011-01-04 11:29:09 +01:00
Georg Brandl
0e1db6ad90 New year update. 2011-01-04 10:00:51 +01:00
Georg Brandl
db8189083d merge with 1.0 2010-10-22 11:16:48 +02:00
Georg Brandl
39dc69e9d9 Remove obsolete config value. 2010-10-22 07:10:44 +02:00
Jonathan Waltman
a5343b4c5b Add documentation for Texinfo builder 2010-09-16 02:16:27 -05:00
Georg Brandl
580e1c90d3 #481, #482: fix `.name` reference matching.
#482: When doing a non-exact search, match only the given type of object.
#481: Apply non-exact search for Python reference targets with ``.name`` for modules too.
2010-08-05 13:39:23 +02:00