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
Roland Meister
32414bf3d3
Add orphan documents as epub_post_files.
2013-02-14 21:34:26 +01:00
Dmitry Shachnev
6d4efb2d1f
Add a versionadded directive
2013-02-11 09:11:18 +04:00
Dmitry Shachnev
0a11494e60
LaTeX writer: include cmap package by default.
...
Also, fix a small typo in config.rst.
2013-02-10 18:02:21 +04:00
Dmitry Shachnev
1c5638e40c
doc/_templates/index.html: fix link to the list of extensions
2013-02-10 16:39:44 +04:00
shirou
c4f107a8cf
add "versionadd".
2013-02-10 01:44:56 +09:00
shirou
3e1ce90183
change "epub_show_urls" option default value to 'inline'.
...
This keeps the current behaviour.
2013-02-09 23:01:42 +09:00
shirou
0635eddd07
add "epub_show_urls" option to doc and quickstart.
2013-02-09 23:00:47 +09:00
shirou
fc63acf3d1
Merged birkenfeld/sphinx into default
2013-02-09 22:44:56 +09:00
Georg Brandl
d8d94e15e3
Add Basque to the list of languages.
2013-02-07 18:50:09 +01:00
shirou
74cce431a3
add epub_show_urls option. This option is almost same as latex_show_urls.
2013-02-06 23:32:12 +09:00
Johannes Dewender
391f99d13a
autodoc: document novalue option
...
The update is listed for version 1.2.
This should be changed if the change is released later.
2013-01-22 17:58:47 +01:00
Takayuki Shimizukawa
fbd63617cf
add installations for each environments
2013-01-20 16:06:04 +09:00
Georg Brandl
926cd01168
Remove devguide mention.
2013-01-19 21:14:22 +01:00
Georg Brandl
20279b07a4
New doc design "sphinx13".
2013-01-18 23:17:11 +01:00
Georg Brandl
0939d6fcdb
New doc design "sphinx13".
2013-01-18 23:17:11 +01:00
Georg Brandl
c59cb9d6f6
docs: document -j option and add changelog
2013-01-14 08:38:46 +01:00
Georg Brandl
2b06c656c1
faq: add sphinx-contrib
2013-01-14 00:07:19 +01:00
Georg Brandl
0701c850d2
faq: add Hieroglyph
2013-01-14 00:02:51 +01:00
Georg Brandl
b8967b4ee8
tutorial: make "documentation collection" clearer
2013-01-14 00:01:18 +01:00
Georg Brandl
1bf5a17534
Closes #1076 : document new sphinx-build options.
2013-01-12 22:45:47 +01:00
Roland Meister
1639f59726
Add includehidden option to the toctree directive
...
This option is equivalent to the includehidden option of the template function
toctree() and allows to restore to the toctree behaviour prior to version 1.1.
See also bug #790 .
2013-01-06 14:55:35 +01:00
Georg Brandl
1832284e89
Closes #1067 : implement pluggable search scorer and tweak scoring to give good results. Patch by Hernan Grecco.
2013-01-04 11:17:32 +01:00
Roland Meister
a0ebe5a3c5
Merge with birkenfeld/sphinx
2013-01-02 09:40:37 +01:00
Georg Brandl
151856819c
Copyright update.
2013-01-01 22:13:15 +01:00
Georg Brandl
998d567d5c
Closes #1065 : in Makefiles, ignore errors in "rm" using the -f flag, not a "-" prefix.
2012-12-31 09:39:02 +01:00
Roland Meister
50fadb9e94
Bug #1047 : templating toctree()'s includehidden argument
...
Document the includehidden option and give it sane defaults.
See bug #1047 for implementation alternatives.
2012-12-10 21:54:11 +01:00
Denis
5b54c253bb
Upgrade for 'default' theme: collapsiblesidebar works with rightsidebar
2012-12-10 14:13:35 +04:00
Jonathan Waltman
beae650645
xml: Update sphinx-build documentation
2012-12-10 02:41:12 -06:00
Jonathan Waltman
8ac4aa6282
Add Docutils-native XML and pseudo-XML builders
2012-12-04 21:10:15 -06:00
Jonathan Waltman
3a8673a66b
devguide: Add guidelines for core developers
2012-12-03 00:55:47 -06:00
Jonathan Waltman
196cb44c30
devguide: Elaborate on pull requests
2012-12-02 01:18:54 -06:00
Jonathan Waltman
0cca0ad7cf
Add initial draft of "Sphinx Developer's Guide"
2012-11-29 19:11:19 -06:00
Georg Brandl
4763419db1
Update Sphinx URL to new sphinx-doc.org domain.
2012-11-04 11:28:12 +01:00
Jonathan Waltman
55b28b0198
Fix whitespace / line length issues reported by "make test"
2012-11-03 11:04:32 -05:00
Robert Lehmann
31536aafa2
Link domains provided by sphinxcontrib.
2012-11-02 16:52:55 +01:00
Robert Lehmann
edebdbbb7b
Update domains provided by sphinxcontrib.
2012-11-02 16:02:32 +01:00
Georg Brandl
d13c0470af
Update requirements documentation.
2012-10-30 10:24:57 +01:00
Georg Brandl
d769d4ae71
Change sphinx-dev to sphinx-users where applicable.
2012-10-30 08:47:20 +01:00
Georg Brandl
0c02841412
Closes #1010 : Make pngmath images transparent by default; IE7+ should handle it.
2012-10-28 19:06:48 +01:00
Georg Brandl
10a65f62ef
Linkcode changelog entry.
2012-10-28 18:22:53 +01:00
Georg Brandl
201883d209
Merged in pv/sphinx-work/ext-linkcode (pull request #47 )
2012-10-28 18:21:57 +01:00
Georg Brandl
88dac45c9e
Fix Norwegian language code.
2012-10-28 18:19:54 +01:00
Georg Brandl
33828e4777
merge with stable
2012-10-28 18:01:57 +01:00
Georg Brandl
883887b57b
Changelog and style fixes for PR#75.
2012-10-28 17:57:40 +01:00
Jonathan Waltman
ead356e3cf
Remove note about sectioning limitation of the "only" directive.
2012-09-12 16:40:10 -05:00
Benoit Bryon
c127ac19bd
Fixed apidoc's --follow-links option in documentation.
2012-08-30 15:51:46 +02:00
Benoit Bryon
236267847c
Fixed documentation of default behaviour for apidoc's '--followlinks' option.
2012-08-30 14:19:10 +02:00
Benoit Bryon
316ddaf732
Added -l, --followlinks option to sphinx-apidoc.
2012-08-30 14:14:44 +02:00
Georg Brandl
c333f515cd
Doc change for d7ac5e46307d
2012-05-08 12:51:28 +02:00
Georg Brandl
a0a7f37ab2
Merge with stable
2012-05-08 12:48:33 +02:00
Georg Brandl
9af2094ca4
Merged in rolmei/sphinx-epub (pull request #56 )
2012-04-11 21:35:35 +02:00
Georg Brandl
fe8ed35dfb
Make it clearer how autodoc special comments have to be formatted.
2012-03-17 16:54:17 +01:00
Pauli Virtanen
da4ba903a3
DOC: linkcode: fix up documentation a bit
2012-03-11 17:55:29 +01:00
Pauli Virtanen
135bb6f6c8
ENH: add a linkcode extension
2012-03-11 17:48:51 +01:00
Georg Brandl
c5513e960c
merge with stable
2012-03-10 21:38:29 +01:00
Georg Brandl
729565b7a9
Fixes #795 : explain that titles on the same level as the document heading cannot be put into only directives.
2012-03-10 21:21:43 +01:00
Georg Brandl
166c7e8d27
Style fixes.
2012-03-10 18:13:55 +01:00
Georg Brandl
94f8dda758
Merged in intgr/sphinx (pull request #45 )
2012-03-10 18:07:16 +01:00
Roland Meister
c20c83140a
Merge with birkenfeld/sphinx
2012-02-28 22:09:53 +01:00
Roland Meister
0d12036da0
Add documentation and automatic entries for the guide element
2012-02-28 21:59:57 +01:00
Marti Raudsepp
fd70920456
Fix docutils links found by linkcheck (with the new anchor checking feature)
2012-02-28 20:34:57 +02:00
Marti Raudsepp
e0e9d2a7fa
Add #anchor checking to 'linkcheck' builder.
...
This requires us to download the document and parse its HTML.
2012-02-28 20:12:59 +02:00
Jeffrey Finkelstein
01a350c198
Added other domains currently listed in the sphinx-contrib repository (including Ada, Erlang, HTTP, PHP, and Ruby).
2012-02-24 01:09:32 -05:00
Georg Brandl
64593b946e
merge with stable
2012-02-19 11:54:53 +01:00
Georg Brandl
1fe365f9cd
Add versionadded tags.
2012-02-18 08:05:41 +01:00
Georg Brandl
ea5dc363e2
Merged in rolmei/sphinx-epub (pull request #42 )
2012-02-18 08:04:31 +01:00
Robert Lehmann
f646779255
Fix typo.
2012-02-15 08:43:26 +01:00
Roland Meister
024b5950dd
Merge with birkenfeld/sphinx
2012-02-13 20:59:37 +01:00
Georg Brandl
cc8a4a8126
Closes #817 : note that math markup in docstrings needs to take care of backslashes.
2012-01-29 12:06:02 +01:00
Georg Brandl
4a8eef8479
Add Slovak translation to docs.
2012-01-29 10:04:29 +01:00
Georg Brandl
5ad2895e73
Add Hungarian translation to docs.
2012-01-29 10:03:09 +01:00
Georg Brandl
53d06fda7b
Closes #793 : Fix docutils version references.
2011-11-01 09:16:37 +01:00
Georg Brandl
9a4a3c9afa
Satisfy "make check".
2011-10-09 23:09:57 +02:00
Robert Lehmann
356b1ab8d3
Fix typo.
2011-10-08 16:17:00 +02:00
Georg Brandl
38ebe67c4e
Closes #585 : document sphinx-apidoc.
2011-10-07 12:47:58 +02:00
Georg Brandl
ff940a16b6
Add a rudimentary manpage for sphinx-apidoc.
2011-10-07 12:27:19 +02:00
Robert Lehmann
b8873fe7b0
Fixes #354 : Addressed PDF generation in the tutorial.
2011-10-06 14:52:54 +02:00
Robert Lehmann
77329bf497
Closes #561 : Add configuration option to prevent catalog bundling.
2011-10-03 13:20:53 +02:00
Georg Brandl
2c77c05473
Merge with 1.0
2011-09-23 22:03:34 +02:00
Georg Brandl
09b5e1736c
Add reference to odt2sphinx.
2011-09-23 11:36:32 +02:00
Georg Brandl
ded4bee328
Add note about inclusion with the "include" directive.
2011-09-23 11:22:35 +02:00
Armin Ronacher
2a021f1cf9
merged
2011-09-23 00:49:08 +02:00
Armin Ronacher
7eae4bcaeb
Attach arrays to the name not the type for C++ domain and fixed a few rendering errors.
2011-09-23 00:48:52 +02:00
Armin Ronacher
5315d23365
Attach arrays to the name not the type for C++ domain and fixed a few rendering errors.
2011-09-23 00:48:52 +02:00
Georg Brandl
07427c48fb
Merge with 1.0.
2011-09-22 14:39:27 +02:00
Georg Brandl
3d4b8830a0
Fix #708 : add reference to Pandoc.
2011-09-22 14:05:03 +02:00
Georg Brandl
ad5d9f7c6b
Add changelog entry for emphasize-lines and some coding style fixes.
2011-09-22 09:29:36 +02:00
Georg Brandl
5373125fc6
Merged in marklodato/sphinx (pull request #4 )
2011-09-22 09:14:50 +02:00
Georg Brandl
e74a5541df
Make it clear that math labels are internal.
2011-09-21 10:21:22 +02:00
Mark Lodato
2c0f936e6b
add :emphasize-lines: option to source-code and literal-include
...
Add a new option, :emphasize-lines:, to the source-code and
literal-include directives. The format is the same as the :lines:
option for literal-include. The resulting list of lines is passed to
the Pygments formatter as 'hl_lines', which is only honored by the HTML
formatter.
2011-07-06 22:58:19 -04:00
Roland Meister
dbe932d30c
Merge with birkenfeld/sphinx.
2011-05-23 21:22:33 +02:00
Roland Meister
0da0c03b53
Added the epub theme options relbar1 and footer.
2011-05-23 21:09:51 +02:00
Georg Brandl
10287a6684
merge with 1.0
2011-05-15 13:52:48 +02:00
Georg Brandl
8965cf1095
Closes #658 : fix error in script_files example and document css_files.
2011-05-15 13:05:31 +02:00
Georg Brandl
99c505b63f
Closes #683 : set default MathJax path to the CDN URL, and update the docs accordingly.
2011-05-15 11:57:23 +02:00
Georg Brandl
8a08f5b42a
Closes #694 : add Latvian locale, thanks to Alexander Smishlajev.
2011-05-15 11:27:01 +02:00
Georg Brandl
1b6e2bfa9c
Fix #766 : Add Estonian locale, thanks to Aivar Annamaa.
2011-09-21 09:28:49 +02:00
Georg Brandl
4718e50f4b
Fix #714 : Add Korean locale, thanks to Channy Yun.
2011-09-21 09:25:37 +02:00
Robert Lehmann
0dd3aa123d
Closes #762 : Update html2rest source location.
2011-09-16 08:25:00 +02:00
Georg Brandl
ed0bad3889
Doc and changelog entries for 91b4fc984b32.
2011-07-23 10:04:09 +02:00
Georg Brandl
680d261694
s/jsmath/mathjax/
2011-07-23 10:02:04 +02:00
bond
bfa6e8c0de
some changes to math docs
2011-07-19 22:35:52 +02:00
Eric Holscher
255433401f
Added Read the Docs to the using documentation
2011-03-20 16:48:42 -07:00
Jonathan Waltman
54290ed0e6
Add :confval:texinfo_show_urls.
2011-03-06 00:30:19 -06:00
Jonathan Waltman
883a7fd3cd
Merge with https://bitbucket.org/birkenfeld/sphinx
2011-03-02 23:54:27 -06:00
Roland Meister
f107cf7787
Fix typo in description for epub_fix_images.
2011-02-28 23:24:48 +01: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
Jonathan Waltman
23bb290c42
Document :confval:texinfo_domain_indices and update quickstart.
2011-02-23 17:55:39 -06:00
Daniel Neuhäuser
e46a8e9ded
Change redirected URLs to the new locations
2011-02-05 21:48:54 +01:00
Jonathan Waltman
9f9c753f7e
Mention the texinfo builder in the sphinx-build man page
2011-01-28 02:34:53 -06:00
Daniel Neuhäuser
53a0729c22
Fixed example in websupports docs. this closes #608
2011-01-16 03:14:46 +01:00
Daniel Neuhäuser
ed32972cbc
http://jinja.pocoo.org/2/ -> http://jinja.pocoo.org/
...
This closes issue #607
2011-01-16 02:36:34 +01:00
Daniel Neuhäuser
8695baa764
Fix typo. This closes issue #606 .
2011-01-16 02:31:40 +01:00
Georg Brandl
bb7bf21c7e
merge with 1.0
2011-01-15 15:47:36 +01:00
Georg Brandl
a63230f12d
#431 : Doc comments for attributes can now be given on the same line as the assignment.
2011-01-15 15:40:59 +01:00
Georg Brandl
bb7b30d912
#595 : Typo fix.
2011-01-15 15:13:57 +01:00
Georg Brandl
f27950b78d
#554 : Add theme option `sidebarwidth` to the basic theme.
2011-01-15 11:33:45 +01:00
Georg Brandl
4e32af4095
#596 : Japanese was missing from the confval:language docs.
2011-01-12 09:36:58 +01:00
Georg Brandl
6e2324ab2c
Add changelog entry and docs for #594 .
2011-01-09 21:43:22 +01:00
Jonathan Waltman
15c94d6947
Change example code to not use an actual control character.
2011-01-08 21:24:11 -06:00
Georg Brandl
87b0ac63ed
merge with 1.0
2011-01-09 00:47:48 +01:00
Georg Brandl
b89e9b4346
Clarification.
2011-01-08 23:50:03 +01:00
Georg Brandl
79ea94870d
Document html_context.
2011-01-08 21:59:49 +01:00
Georg Brandl
6c23616b2c
merge with 1.0
2011-01-08 20:09:29 +01:00
Georg Brandl
568c293226
Add link to sphinx-wiki.
2011-01-08 20:05:41 +01:00
Georg Brandl
aa0c862d92
Fix typo.
2011-01-08 19:21:34 +01:00
Georg Brandl
bc6b586836
Added :confval:pngmath_add_tooltips.
2011-01-08 19:08:38 +01:00
Georg Brandl
23d2d534df
Non-dev Python docs are now Sphinx too.
2011-01-07 22:07:15 +01:00
Georg Brandl
210add8d2c
Parse parmeter field in event descriptions.
2011-01-07 16:27:47 +01:00
Georg Brandl
8a3598ff8e
Cross-reference to role docs.
2011-01-06 20:44:55 +01:00
Georg Brandl
e8d4fa759e
Update github pages advice.
2011-01-05 18:12:51 +01:00
