Commit Graph

4289 Commits

Author SHA1 Message Date
Georg Brandl
d521ebf93e Fixup docfield example usage. 2013-09-16 03:51:02 +02:00
dc mouser
3f888742ff Added option to apidoc to have it output each module to its own page and updated apidoc docs. 2013-09-08 16:25:41 -05:00
Kevin Burke
8faf315643 Add more inline examples
The idea is to show off all of the supported functionality of Sphinx
autodocs for domains in the given example. I always get confused about
the format for raised exceptions, etc. It would be great if this was a
little bit more of a comprehensive reference.
2013-09-05 09:52:54 -07:00
dc mouser
cc570edf37 Added option to apidoc to write each module to standalone page instead of combining all modules in a package on one page. 2013-09-03 15:52:56 -05:00
David Li
edb8bda9dd Sidebar: strip spaces from cookie key
This ensures the sidebar will correctly restore its open/closed
state.
2013-08-31 16:56:08 +00:00
Matthias C. M. Troffaes
af73fc486e Actual implementation. 2013-08-22 09:30:25 +01:00
Matthias C. M. Troffaes
e20c82a277 Test that extra entries are in outdir. 2013-08-22 09:24:00 +01:00
Matthias C. M. Troffaes
28873bfa6a Set up initial test. 2013-08-22 09:20:47 +01:00
Matthias C. M. Troffaes
57aceed4ed Add and document html_extra_path option. 2013-08-22 08:51:06 +01:00
Roland Meister
88c72be190 Add warning for unusual chars in filenames. Closes #1199 2013-08-10 15:36:05 +02:00
Roland Meister
2f18f710f7 Unify usage of os.path/path in EpubBuilder. 2013-08-10 15:10:20 +02:00
Roland Meister
548325c4e9 Avoid confusing PIL warning for vector graphics (epub builder). 2013-08-10 15:06:06 +02:00
Roland Meister
f010460438 Unify exceptions caught in EpubBuilder.copy_image_files 2013-08-10 14:20:21 +02:00
Takayuki Shimizukawa
dfd9f1cdc8 Sphinx generates broken ePub on Windows. Closes #1232 2013-08-10 18:25:28 +09:00
Tres Walsh
829a5150da Add support for C++11 member function ref-qualifiers and C++03 volatile member function ref-qualifier
Specifically, support for the following has been added:

 * rvalue reference for *this
 * volatile
 * override keyword support

Additionally support for '= default' and '= delete' has been added.

Several tests have also been added to test_cpp_domain.py to insure that these features actually work.
2013-08-07 09:24:32 -07:00
cancerhermit
b368e1e6ee Merged in cancerhermit/fix-override-extensions-in-configpy-1375648717102 (pull request #1)
override extensions in config.py
2013-08-05 10:51:13 +04:00
cancerhermit
cd3d3d2180 override extensions in config.py 2013-08-04 20:41:34 +00:00
Takayuki Shimizukawa
04d22a53d5 support parallel testing with detox 2013-07-27 16:15:36 +09:00
Takayuki Shimizukawa
91ef671ea9 Add test for docutils.conf and prevent 'html4css1.css' missing warning.
Now --embed-stylesheet option default become false.
2013-07-27 14:13:15 +09:00
Takayuki Shimizukawa
fa7fe88d74 Add some URLs to example list. 2013-07-27 00:40:08 +09:00
Takayuki Shimizukawa
f26de54a12 Support docutils.conf 'writers' and 'html4css1 writer' section by html writer.
latex, manpage and texinfo writers support 'writers' section.
2013-07-26 23:23:46 +09:00
Takayuki Shimizukawa
72a6bfde28 add docutils-0.11 for testing 2013-07-25 00:26:43 +00:00
Takayuki Shimizukawa
d23387d82e for testing: change docutils version spec 0.10.0 -> 0.10 2013-07-25 00:24:19 +00:00
Takayuki Shimizukawa
d9f5439ffe fix: broken document format (rst) 2013-07-14 14:43:21 +09:00
Lennart Regebro
f76644fae3 Table improvements in latex:
- The table headers now use header fonts.
- The hlines are in better places.
2013-07-12 23:02:06 +02:00
Takayuki Shimizukawa
a8282e2291 Merged in ericholscher/sphinx (pull request #150)
A pull request with some developer documentation updates
2013-07-12 08:49:13 +09:00
Eric Holscher
f62a28d805 Add link to referenced docutils docs. 2013-07-11 13:30:17 -07:00
Takayuki Shimizukawa
33c9e1fb28 Fix i18n: gettext did not translate admonition directive's title. Closes #1206 2013-07-03 08:19:10 +00:00
Eric Holscher
ec494bec07 Add documentation to the undocumented builder methods. 2013-07-02 22:58:34 -07:00
Eric Holscher
3cd2b24fc5 Add a link to a blog post explaining docutils Writers/Translators 2013-07-02 22:54:32 -07:00
Takayuki Shimizukawa
cb11246754 Merged in rolmei/sphinx-epub (pull request #148)
new predefined tags; epub fixes.
2013-07-01 13:37:34 +09:00
Takayuki Shimizukawa
ab5c7a36be Fix ZeroDivisionError in Parallel Builds. Thanks to tychoish. Closes #1172 2013-07-01 04:27:45 +00:00
Takayuki Shimizukawa
8818b9a0c4 Merged in tychoish/sphinx (pull request #146)
resolve issue #1172: don't divide by zero
2013-07-01 13:24:55 +09:00
tychoish
964a593266 Merged in tychoish/sphinx-1/tychoish/removed-version-change-1372634421412 (pull request #1)
removed version change
2013-06-30 19:21:14 -04:00
tychoish
d57589a1eb removed version change 2013-06-30 23:20:44 +00:00
Rob Ruana
718f4a6f8c Fix #1203: Does not append space to unknown field names.
If an unknown field name is encountered, a space is only
appended if the field arguments are not empty. Also,
only the first character of the field name is upper cased,
and the case of the rest of the string remains unchanged.
2013-06-23 16:06:45 -04:00
Takayuki Shimizukawa
7904b0678a Fix i18n: footnote reference number missing for auto numbered named footnote and auto symbol footnote. Closes #1176 2013-06-21 03:28:32 +00:00
Takayuki Shimizukawa
2cdb6b03c9 test improvement 2013-06-21 01:09:13 +00:00
Roland Meister
409e29023b Merged birkenfeld/sphinx into default 2013-06-19 21:04:31 +02: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
Roland Meister
46debd9f17 Rename title of the epub cover guide
Calibre needs the title "Cover" to show the cover image.
2013-06-19 20:56:48 +02:00
Roland Meister
812d5cc181 Remove ids from copied todo directives; they are no longer unique in the todolist 2013-06-19 20:39:13 +02:00
Takayuki Shimizukawa
4579bb6e85 fix: translation mechanism break label target if label and section name are same. refs #1193 2013-06-19 06:07:47 +00:00
Takayuki Shimizukawa
f9b733fc47 test_intl:external_link test case correction to fit to reST syntax. 2013-06-18 11:14:27 +00:00
Takayuki Shimizukawa
a997f98333 fix: keep reference if link refname was translated. refs #1193
case1::

   Keep link to ExternalSite_.

   It will translated with ``\`SomeOtherString\`_``.

   .. _ExternalSite: http://example.com

case2::

   Keep link to `title string`_ before appearing.

   title string
   =============

case3::

   Keep link to glossary 'term string'.

   .. glossary::

      term string
         description...
2013-06-19 10:42:26 +00:00
Takayuki Shimizukawa
430d0e9895 fix: Duplicated section name will cause crash. refs #1193 2013-06-17 04:34:45 +00:00
Takayuki Shimizukawa
9bd30c748e update comment 2013-06-17 04:24:12 +00:00
Takayuki Shimizukawa
afc6b6d1f8 Fix: Multiple references in the same line return the same link with i18n. Closes #1193 2013-06-17 00:12:02 +09:00
Takayuki Shimizukawa
bd4da7df55 add tests for "multiple cross references in the same line return the same link". refs #1090, #1193 2013-06-16 14:25:29 +09:00
Takayuki Shimizukawa
deb01d8e30 Fix multiple cross references (term, ref, doc) in the same line return the same link with i18n. refs #1090, #1193 2013-06-16 23:57:08 +09:00