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
4,256 Commits 2 Branches 219 Tags 163 MiB
ec453b94e7
Commit Graph

891 Commits

Author SHA1 Message Date
Georg Brandl
4b3a0b677d Add the cover of the Learning Sphinx book as an image. 2013-09-16 05:17:38 +02:00
Georg Brandl
900c50dd92 merge with stable 2013-09-16 05:10:27 +02:00
Georg Brandl
3541cef023 Update link to Japanese translation of the docs, and a link to the new OReilly book. 2013-09-16 05:09:05 +02:00
Georg Brandl
7c7c5af02a Merged in mcmtroffaes/sphinx-html-extra-path (pull request #158) 
Add html_extra_path option to copy additional files ad verbatim to the output root folder.
 2013-09-16 04:28:22 +02:00
Georg Brandl
e732807869 Merged in JonnyJD/sphinx/autodoc_novalue (pull request #109) 
feature: autodoc: add :annotation: option for autodata and autoattribute
 2013-09-16 04:25:53 +02:00
Georg Brandl
d521ebf93e Fixup docfield example usage. 2013-09-16 03:51:02 +02: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
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
Takayuki Shimizukawa
d9f5439ffe fix: broken document format (rst) 2013-07-14 14:43:21 +09:00
Eric Holscher
f62a28d805 Add link to referenced docutils docs. 2013-07-11 13:30:17 -07: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
cc909ab2a9 More docs cleanup; add hint for the epub cover page 2013-06-07 20:48:14 +02:00
Roland Meister
2f5b7b8db1 Adjust docs about inline URLs for the epub builder 2013-06-06 21:53:59 +02:00
Roland Meister
ce6b8fff70 Clarify docs for the format and builder tags 2013-06-06 21:23:16 +02:00
Roland Meister
f879346cea Add the builder name as predefined tag for the only directive. 
At the moment only the epub builder distinguishes between format and name.
Explicit entries with format_ and builder_ prefix are also added.
 2013-04-25 23:08:30 +02:00
Takayuki Shimizukawa
75a128b0f8 integrate 'translationguide.rst' into 'intl.rst' 2013-04-13 18:16:48 +09:00
Takayuki Shimizukawa
3b9ae95d01 update translation document 2013-04-11 23:45:15 +09:00
Roland Meister
36157e7cb8 Merged in rolmei/sphinx-epub (pull request #129) 
footnote setting for epub_show urls
 2013-04-08 23:14:05 +02:00
Georg Brandl
ff769018ca Add a section about updating locales to the devguide. 2013-04-05 16:42:47 +02:00
Roland Meister
c56b6aabcf Merge with birkenfeld/sphinx 2013-04-03 19:06:01 +02:00
Roland Meister
510ec71d07 Merged in rolmei/sphinx-epub (pull request #126) 
New option epub_tocscope
 2013-04-03 18:47:24 +02:00
Nozomu Kaneko
c505f70439 Update the draft of Sphinx Document Translation Guide 2013-04-03 03:25:53 +09:00
Takayuki Shimizukawa
d7e6ab3cfc add first draft for sphinx document translation 2013-04-03 00:11:55 +09: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
Georg Brandl
08839fac68 docs: fix link to MathJax documentation 2013-03-30 14:08:33 +01:00
Georg Brandl
0237940007 remove stray quote 2013-03-30 12:48:21 +01:00
Georg Brandl
ba39edb5db merge with parallel repo 2013-03-29 13:01:21 +01:00
Georg Brandl
dea5b77bb3 docs: add versionadded to epub_use_index confval 2013-03-29 12:49:53 +01:00
Georg Brandl
d492aad352 docs: proofread installation document 2013-03-29 11:45:07 +01:00
Takayuki Shimizukawa
e30b1325ef Because it was thought MaxJax CDN URL has not been written intentionally, I undo the changes. 
See also #683.
Backed out changeset 2f9a30b7d005.
 2013-03-29 10:52:52 +09:00
Takayuki Shimizukawa
c4a999f682 add missing mathjax_path default value in document. 2013-03-29 10:45:24 +09:00
Roland Meister
234c0c0c75 New 'footnote' setting for epub_show_links. 2013-03-11 21:59:53 +01:00
Roland Meister
948991ed28 Merge with birkenfeld/sphnx 2013-03-10 15:30:06 +01:00
Takayuki Shimizukawa
2c409959ac Add i18n capabilities for custom templates. 
For example: The Sphinx reference documentation in doc directory provides
sphinx.pot file from ``doc/_templates/*.html`` by ``make gettext``.
 2013-03-10 22:07:31 +09:00
Takayuki Shimizukawa
9afd86a569 Merged in rolmei/sphinx-epub (pull request #123) 
epub_use_index instead of html_use_index for epub builder (Issue #1106)
 2013-03-10 10:19:49 +09:00
shirou
fbd60fc0c9 change 1.1.3 to 1.2 about latex_additional_files in conf.py document. 2013-03-07 11:05:33 +09:00
Roland Meister
4507ada0bc Add new setting epub_tocscope for epub builder. 
The new setting replaces the old heuristic that was never that good.
 2013-03-06 20:48:00 +01: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
shirou
8bec3b8777 move "copy additional files" after "copying TeX support files" in latex builder. 
It enables the user to override TeX support files such as sphinx.sty by setting latex_additional_files.
 2013-03-05 22:17:05 +09:00
Johannes Dewender
649ab8030c autodoc: change :novalue: to :annoation: option 
The :novalue: option is now called :annotation: and has an additional feature:
When given with an argument, you can specify what the annotation
of the object will be.
 2013-02-27 16:38:55 +01:00
Jonathan Waltman
15b34a0940 Set latex_elements['fontpkg'] = '' for Cyrillic languages (suggested by Dmitry Shachnev) 2013-02-22 02:16:02 -06:00
Jonathan Waltman
3019758150 Merged in mitya57/sphinx (pull request #114) 
LaTeX writer: include cmap package by default
 2013-02-22 01:36:07 -06:00
Jonathan Waltman
eb88e37040 Merged in rolmei/sphinx-epub (pull request #117) 
Some small fixes
 2013-02-20 15:20:04 -06:00
Jonathan Waltman
c9a5c78a20 Changelog entry for pull request 115 and doc update. 2013-02-20 15:11:45 -06:00
Jonathan Waltman
50d4aec15c [texinfo] Update CHANGES and relevant documentation. 2013-02-20 04:09:50 -06:00
Jonathan Waltman
e3a27b76f2 Closes #1110: Add new config value texinfo_no_detailmenu and do not generate detailed menus for non-"Top" nodes. 2013-02-19 03:24:57 -06:00
Roland Meister
12d0574aee Merge with birkenfeld/sphinx 2013-02-14 21:47:58 +01:00
Roland Meister
0525c97427 Rename pythonorg.jpg to proper pythonorg.png. 2013-02-14 21:46:11 +01:00