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
6,382 Commits 2 Branches 219 Tags 163 MiB
a8dabf334d
Commit Graph

1293 Commits

Author SHA1 Message Date
Georg Brandl
38f47bc0ef Closes #1356: link to page with valid Pygments lexer alias 2014-01-22 17:28:04 +01:00
shibukawa yoshiki
6bda4586bd Add development memo about stemming JS code, acceleration tips about stemming, small bug fix 2014-01-22 02:12:04 -08:00
shibukawa yoshiki
18722362db update document 2014-01-22 00:34:14 -08:00
Georg Brandl
fb5a1a09a0 some directive creation docs 2014-01-21 10:32:30 +01:00
Georg Brandl
6b33e3fea4 remove duplicate wording 2014-01-21 10:05:23 +01:00
Georg Brandl
cc8d29dcab actually use exception markup 2014-01-21 10:04:11 +01:00
Georg Brandl
da09100869 doc: add exceptions from sphinx.errors 2014-01-21 09:54:31 +01:00
Georg Brandl
317930a7fb merge with stable 2014-01-20 21:21:33 +01:00
Georg Brandl
fe5ac65311 Merged in ViktorHaag/sphinx/stable (pull request #211) 
Fix for issue #1352
 2014-01-20 21:16:33 +01:00
Viktor Haag
3c0c9cd198 updates per Georg Brandl: 
- Change alteration to docs to express path relative to "configuration directory" and not "conf.py"
- Update block in HTML builder copying favicon to _static to mirror handling of html_logo
 2014-01-20 13:27:52 -05:00
Georg Brandl
883324fd6c Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00
Viktor Haag
549b176c85 merge to tip 2014-01-20 10:37:51 -05:00
Viktor Haag
3706ed02ac address issue #1352 -- make sure to check for the actual file stored in config.html_logo. 2014-01-20 10:37:37 -05:00
Georg Brandl
aecf35c1bd mention loglevel 2014-01-20 11:21:30 +01:00
Georg Brandl
8115aa81a2 merge with stable 2014-01-20 08:54:40 +01:00
Georg Brandl
0e182d1d2b devguide: small updates 2014-01-20 08:51:47 +01:00
Rob Ruana
4219cd32c8 Merging changes 2014-01-19 13:44:28 -05:00
Rob Ruana
63fbb819c7 Makes suggested changes before adding napoleon to sphinx 2014-01-19 13:43:54 -05:00
Rob Ruana
3dcf8f4119 Merged birkenfeld/sphinx into default 2014-01-19 13:40:06 -05:00
Georg Brandl
66e64b9530 merge with stable 2014-01-19 19:13:17 +01:00
Rob Ruana
4c782604ed Merged birkenfeld/sphinx into default 2014-01-19 12:31:07 -05:00
Georg Brandl
ce49286240 Closes #1071: add mention of "orphan" to toctree docs 2014-01-19 18:12:52 +01:00
Georg Brandl
48aeed6fd8 add back missing @ 2014-01-19 17:49:57 +01:00
Georg Brandl
8c2fabe117 The deprecated config values `exclude_trees, exclude_dirnames and unused_docs` have been removed. 2014-01-19 17:46:06 +01:00
Georg Brandl
81b10b9b73 merge with stable 2014-01-19 17:41:41 +01:00
Georg Brandl
1653c5d242 Make mode: refactor using a class and add source dir to the makefile 2014-01-19 16:23:23 +01:00
Georg Brandl
411d88a90e Merged in birkenfeld/sphinx-new-make-mode/stable (pull request #203) 
Add "make mode" to sphinx-build, invoked by the -M flag.
 2014-01-19 15:38:23 +01:00
Georg Brandl
0d1aab9a45 Merged in keimlink/sphinx/improve-tags-docs (pull request #167) 
Explain that only tags set via command-line or tags.add() are available
 2014-01-19 11:09:42 +01:00
Georg Brandl
2458e5731a Add :filename: also for literalinclude. Changelog entry. 2014-01-19 11:04:12 +01:00
Georg Brandl
5023da8ac3 mock: little changes, changelog and versionadded 2014-01-19 10:34:52 +01:00
Georg Brandl
91cd11be3c Merged in guibog/sphinx2 (pull request #184) 
autodoc extension: add autodoc_mock_imports config value
 2014-01-19 10:31:15 +01:00
Rob Ruana
d11cb7325e Merge conflicts 2014-01-18 14:23:23 -05:00
Rob Ruana
a00a096069 Merges napoleon extension into mainline sphinx 2014-01-18 13:56:23 -05:00
Takayuki Shimizukawa
db9d91e8cc remove note it become useless anymore. 2014-01-18 21:47:20 +09:00
Takayuki Shimizukawa
c5bd935001 merge heads 2014-01-18 20:41:43 +09:00
Takayuki Shimizukawa
dd41adf0a0 merge heads 2014-01-18 16:34:47 +09:00
Georg Brandl
24a8b516bf Remove sphinx.ext.oldcmarkup compatibility extension. 2014-01-17 07:24:23 +01:00
Takayuki Shimizukawa
cc7509966c merge heads 2014-01-15 05:25:56 +00:00
Georg Brandl
dbd544d12b More tweaks to the py domain docs. 2014-01-13 20:13:44 +01:00
Georg Brandl
1723a09d72 merge with stable 2014-01-13 19:15:10 +01:00
Georg Brandl
78b5d9aac2 Overhaul py directive documentation, remove old practices. 2014-01-13 19:12:42 +01:00
Georg Brandl
d133f028af merge with stable 2014-01-13 00:14:00 +01:00
Georg Brandl
9708319f5c docs: fix some broken links 2014-01-13 00:05:22 +01:00
Georg Brandl
a72406d434 Closes #1328: clarify that builder-specific tags are not available when conf.py is executed. 2014-01-12 22:40:50 +01:00
Georg Brandl
dd73c32892 merge with stable 2014-01-12 20:46:50 +01:00
Georg Brandl
123572e1db #1345: Fix two bugs with :confval:nitpick_ignore; now you don't have to 
remove the store environment for changes to have effect.
 2014-01-12 20:45:34 +01:00
Georg Brandl
82e4751ed0 merge with stable 2014-01-12 17:04:58 +01:00
Georg Brandl
06364ca784 Closes #1174: Fix smart quotes being applied inside roles like :rst:role:program or :rst:role:makevar. 2014-01-12 17:01:22 +01:00
Georg Brandl
3f1235e2ea doc: note that "image" paths should not have spaces. 2014-01-12 16:28:27 +01:00
Georg Brandl
31aed07386 Closes #1156: bring manpage up to scratch with current options and builders. 2014-01-12 16:07:21 +01:00
Georg Brandl
9d25862700 add link to "write the docs", move hosting chapter to home page 2014-01-12 12:44:36 +01:00
Georg Brandl
d38c5cac8d Closes #1082: clarify that html_title default value does not really have placeholders 2014-01-11 21:03:56 +01:00
Georg Brandl
48524dcecc Closes #983: clarify "docstitle" behavior with singlehtml 2014-01-11 20:18:37 +01:00
Georg Brandl
453290fc66 doc: make it more prominent that sub-toctrees shouldnt get :numbered: 
Should be enforced programmatically at some point!
 2014-01-11 19:54:47 +01:00
Georg Brandl
91d92be8ad Add "make mode" to sphinx-build, invoked by the -M flag. 
This is intended to do almost all of what the quickstart-generated Makefile
and make.bat did, but within Sphinx.  The advantages are:

* no duplication between Unix and Windows files
* updates and fixes are propagated (the generated makefiles never update)
* more Python code, less shell code!
 2014-01-11 19:36:05 +01:00
Georg Brandl
1d564ace28 merge stable into default 2014-01-11 14:53:07 +01:00
Georg Brandl
6deebc4ef0 minor doc fixes 2014-01-11 14:52:41 +01:00
Georg Brandl
b29226a060 Closes #845: In code blocks, when the selected lexer fails, display line numbers nevertheless if configured. 2014-01-11 10:00:49 +01:00
Georg Brandl
269ef714f3 Closes #668: Allow line numbering of `code-block and literalinclude` directives 
#to start at an arbitrary line number, with a new ``lineno-start`` option.
 2014-01-11 08:44:45 +01:00
Georg Brandl
5394fbb82b merge stable into default 2014-01-11 08:14:55 +01:00
Georg Brandl
166ac0d5ca fix target confusion 2014-01-10 21:44:59 +01:00
Georg Brandl
1356aff6d7 Closes #925: Allow list-typed config values to be provided on the command line, 
like ``-D key=val1,val2``.
 2014-01-10 21:44:14 +01:00
Georg Brandl
865d677eb8 merge stable into default 2014-01-10 21:26:12 +01:00
Georg Brandl
8b2417bc6d small fixes in intl document 2014-01-10 21:25:59 +01:00
Georg Brandl
2b6dc512b8 doc intro: add a pointer to readthedocs.org 2014-01-10 15:22:39 +01:00
Georg Brandl
9a890a45c1 merge with stable 2014-01-10 14:57:43 +01:00
Georg Brandl
bae7682bad merge with intersphinx tutorial section 2014-01-10 14:55:25 +01:00
Georg Brandl
fcee847ae0 Merged in plaindocs/sphinx (pull request #185) 2014-01-10 09:24:23 +01:00
Takayuki Shimizukawa
bcff26c6da update a Intersphinx tutorial section. refs #1325 2013-12-18 08:33:37 +09:00
Eric Knibbe
6c70ea2aae corrected descriptions of tabularcolumns specifiers 2013-12-17 18:14:28 +00:00
Eric Knibbe
3c8de18e86 corrected descriptions of tabularcolumns specifiers 2013-12-17 18:14:28 +00:00
Eric Knibbe
9298e15ae0 recommend exclude_patterns instead of unused_docs or exclude_trees 2013-12-17 18:12:54 +00:00
Eric Knibbe
d952469a22 recommend exclude_patterns instead of unused_docs or exclude_trees 2013-12-17 18:12:54 +00:00
Takayuki Shimizukawa
1367f6f9c6 Added a "Intersphinx" tutorial section. (:file:doc/tutorial.rst). Closes #1325 2013-12-17 23:54:30 +09:00
Takayuki Shimizukawa
2050285ebf Drop docutils-0.7, 0.8 and 0.9 support 2013-12-15 16:25:01 +09:00
Takayuki Shimizukawa
f7cb510ebd Drop python-3.1 and remove support codes 2013-12-15 16:04:23 +09:00
Takayuki Shimizukawa
a8fc938d1b Drop python-2.5 and remove 2.4,2.5 support codes 2013-12-15 14:16:53 +09:00
Samuel Wright
4784bb7e32 Removed duplicate comma. 2013-12-10 19:42:47 +01:00
Georg Brandl
5dedeb30b0 py:decorator clarification 2013-11-25 20:43:23 +01:00
Georg Brandl
1efbc75905 Clarify use of signatures in python domain directives. 2013-11-24 16:02:34 +01:00
Samuel Wright
4bcb7a2c1b Fixed wording. 2013-10-25 13:22:01 +02:00
Samuel Wright
b3286c6b82 Fix for Issue #1071 2013-10-25 13:08:03 +02:00
guibog
a8f65e9d3c autodoc extension: add autodoc_mock_imports config value 2013-10-23 16:36:45 +08:00
Georg Brandl
c5ff9386d6 Fix autodoc. 2013-10-12 21:01:25 +02:00
Georg Brandl
695cebd254 Add sphinx.version_info for better programmatic check of the Sphinx version. 2013-10-12 20:48:03 +02:00
Georg Brandl
ea8fad0de6 Removed the `sphinx.ext.refcounting` extension -- it is very specific to 
CPython and has no place in the main distribution.
 2013-10-12 19:27:49 +02:00
Eric Knibbe
0b22e43653 Added more domain links. 2013-10-08 14:35:32 +00:00
Takayuki Shimizukawa
e81a2d884e Added a ez_setup to replace distribute_setup. ez_setup become defacto. Closes #1264 2013-10-03 05:55:58 +00:00
Georg Brandl
8870db8787 grammar fix 2013-10-01 19:51:45 +02:00
Takayuki Shimizukawa
dab3f56267 Merged in erikb85/sphinx (pull request #154) 
Removing "sphinx" prefix from Latex class parsing
 2013-09-23 22:53:10 +09:00
Erik Bernoth
831f450bba Note in the documentation, that prepending "sphinx" is not necessary anymore. 2013-09-23 13:54:18 +02:00
anatoly techtonik
02123adce4 add link to IRC channel 2013-09-21 07:55:37 +00:00
Markus Zapke-Gründemann
d7caa3fa20 Explain that only tags set via command-line or tags.add() are available 2013-09-19 21:48:54 +02:00
Georg Brandl
d0cf2617cf Merged in dcmouser/sphinx-fork-dcmouser (pull request #161) 
Added option to apidoc to write each module to standalone page instead of combining all modules in a package on one page.
 2013-09-17 14:39:04 +02:00
Georg Brandl
7b8f78afac Small doc fixes for setuptools change. 2013-09-17 07:51:30 +02:00
Takayuki Shimizukawa
93e7623cd8 Add feature: theme package collection by using setuptools plugin mechanism. 2013-09-16 23:57:58 +09:00
Georg Brandl
44418fd1a1 changelog update for PR#136 2013-09-16 09:26:14 +02:00
Georg Brandl
d2b4f9a095 Merged in Vladimirsson/sphinx (pull request #136) 
Added ``imported-members`` option for ``automodule`` directive in autodoc
 2013-09-16 09:23:56 +02:00
Georg Brandl
de2e47bfce IRC channel update. 2013-09-16 09:16:08 +02:00
Georg Brandl
eafc199e06 Locale update: new locales, others updated from Transifex. 2013-09-16 09:02:06 +02:00
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
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
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
Bogdan Opanchuk
a7a4f7569a Added `imported-members option for automodule` directive in autodoc 2013-04-20 21:58:18 +10: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
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
Georg Brandl
0e1db6ad90 New year update. 2011-01-04 10:00:51 +01:00
Georg Brandl
a484a62f11 #578: doc clarification. 2011-01-04 00:08:38 +01:00
Georg Brandl
63db45dea9 Even more tweaking of the latex tabular environment selection code. 2011-01-03 23:34:57 +01:00
Georg Brandl
6964bdffb9 #565: In the LaTeX builder, not only literal blocks require different table handling, but also quite a few other list-like block elements. 2011-01-03 20:48:11 +01:00
Georg Brandl
3e8834503f #550: fix confusing example in docs. 2010-11-12 08:26:20 +01:00
Pauli Virtanen
e1be6ef8f8 autosummary: minor doc clarifications 2011-06-29 21:27:43 +02:00
Gary Wilson Jr.
175bc520e1 Fixed a couple links in the documentation for the contents docutils directive that were referring to the incorrect anchor. 2011-06-28 13:13:08 -05:00
Georg Brandl
517acb80f0 Add Nepali translation, thanks to Arati Sharma. 2011-06-07 17:17:54 +02:00
Georg Brandl
39dc69e9d9 Remove obsolete config value. 2010-10-22 07:10:44 +02:00
Georg Brandl
991d0e32b3 Fix missing paren. 2010-10-20 11:55:11 +02:00
Georg Brandl
08047fc523 Add Pocoo logo to the sidebar on the index page. 2010-10-18 18:06:02 +02:00
Georg Brandl
817937c3f2 "inofficial" sounds strange here; fix up description of wiki page. 2010-10-10 21:47:03 +02:00
Daniel Neuhäuser
c0fa71a547 Mention Sphinx Contrib in the documentation. 
Along with that I also removed the part about finding a place
to host extensions when a message about one is send to the
mailinglist, as I believe we have one for every extension
with Sphinx Contrib.
 2010-10-10 20:00:12 +02:00
Georg Brandl
c117b8524f Add link to standard markup description. 2010-09-10 09:05:00 +02:00
Georg Brandl
2450c655fe merge 2010-08-26 16:26:16 +00:00
Georg Brandl
7e5ff71c40 #513: Allow giving non-local URIs for JavaScript files, e.g. in the JSMath extension. 2010-08-25 10:26:15 +00:00
Georg Brandl
103f258d83 #497: Introduce separate background color for the sidebar collapse button, making it easier to see. 2010-08-23 16:11:26 +00:00
Georg Brandl
ab334a2a6f Fix sectioning. 2010-08-23 15:58:26 +00:00
Georg Brandl
9d7b75aa5d Clarify example. 2010-08-19 00:02:26 +02:00
Roland Meister
004d706004 Added epub_cover configuration option. 2010-08-06 22:50:41 +02:00
Roland Meister
85a63e297e Empty titles in epub_pre/post_files add no entry in toc.ncx. 2010-08-05 23:08:55 +02:00
Roland Meister
7a41ec29b8 Empty titles in epub_pre/post_files add no entry in toc.ncx. 2010-08-05 23:08:55 +02:00
Georg Brandl
7518d19437 #469: document __all__ ordering in members. 2010-08-05 18:59:04 +02:00
Georg Brandl
df107e70f8 Allow breaking long signatures, continuing with backlash-escaped newlines. 2010-08-05 16:03:36 +02:00
Georg Brandl
92142bbdb6 Allow references to PEPs and RFCs with explicit anchors. 2010-08-05 15:42:15 +02: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
Georg Brandl
01c501054e #480: Fix handling of target naming in intersphinx. 2010-08-05 11:58:43 +02:00
Georg Brandl
cb26c78079 Describe the "deprecated" directive. 2010-07-29 09:27:46 +02:00
Georg Brandl
13017eecc8 Go to #pocoo. 2010-07-28 14:53:39 +02:00
Georg Brandl
2380957682 #266: Add Bengali locale, thanks to Nasimul Haque. 2010-07-27 14:36:47 +02:00
Georg Brandl
5fd37f16e4 merge with bb:rolmei/sphinx-epub. 2010-07-22 15:04:22 +01:00
Georg Brandl
e7405554a7 Adjust alignment. 2010-07-17 19:52:54 +02:00
Georg Brandl
2b29038d0c The behavior of :confval:html_file_suffix changed slightly: the empty string now means "no suffix" instead of "default suffix", use `None` for "default suffix". 2010-07-17 19:45:54 +02:00
Georg Brandl
400617e692 #461: elaborate how to use intersphinx. 2010-07-10 16:59:23 +02:00
Georg Brandl
d0900e8862 #465: update version requirement. 2010-07-10 16:50:32 +02:00
Roland Meister
7cbe0588a9 Added new config parameter epub_tocdup. 2010-07-10 16:33:43 +02:00
Roland Meister
0dd1e93bed Merge with http://bitbucket.org/birkenfeld/sphinx 2010-06-30 21:34:35 +02:00
Georg Brandl
bd1c19d724 Added Lithuanian translation, thanks to Dalius Dobravolskas. 2010-06-20 12:19:34 +02:00
Georg Brandl
f5ecd62d05 #537: Added :confval:nitpick_ignore. 2011-01-08 18:36:52 +01:00
Georg Brandl
1961a4aaa8 Fix typo in name. 2011-01-08 18:06:38 +01:00
Georg Brandl
c266128c6d Rename "intl" module to "gettext", to make it easier to find. Distinguish environments with different versioning methods and always give the gettext builder its own doctree dir. 2011-01-08 17:32:32 +01:00
Georg Brandl
e48f7eb09a Fix interpolation error, encode inserted caption strings and add the caption in HTML output too. 2011-01-08 15:39:35 +01:00
Georg Brandl
c6028c4405 #478: Added :rst:dir:py:decorator directive to describe decorators. 2011-01-08 10:07:42 +01:00
Georg Brandl
d3ab0abce6 merge with 1.0 2011-01-08 00:11:37 +01:00
Georg Brandl
30f85dab6e #367: Added automatic exclusion of hidden members in inheritance diagrams, and an option to selectively enable it. 2011-01-07 22:35:57 +01:00
Georg Brandl
5c39cfb6e9 merge with 1.0 2011-01-07 19:04:53 +01:00
Georg Brandl
bf767d5222 #454: Add more index markup capabilities: marking see/seealso entries, and main entries for a given key. 2011-01-07 19:00:29 +01:00
Georg Brandl
98d884da6e #306: Added :event:env-get-outdated event. 2011-01-07 16:41:44 +01:00
Georg Brandl
763789463d merge with 1.0 2011-01-06 20:59:33 +01:00
Georg Brandl
f925de6aa0 #586: Implemented improved glossary markup which allows multiple terms per definition. 2011-01-06 20:34:41 +01:00
Georg Brandl
3020799a1e Add explicit hl language. 2011-01-06 19:42:37 +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
549c800f0b Remove control character. 2011-01-06 18:21:24 +01:00
Georg Brandl
772c94ef69 Remove latex-unsupported footnote in caption. 2011-01-06 18:20:57 +01:00
Georg Brandl
1675a454ce Added the :mod:sphinx.ext.mathjax extension, based on 
https://bitbucket.org/kevindunn/sphinx-extension-mathjax/ by Kevin Dunn.
 2011-01-06 13:21:36 +01:00
Georg Brandl
208e8a66e2 Add an option for the coverage builder if source-undocumented items are matched. 2011-01-04 22:50:13 +01:00
Georg Brandl
dd6984b7a9 merge with bb://mbrochh/sphinx 2011-01-04 22:22:23 +01:00
Georg Brandl
560e803cc1 merge with bb+http://jonathanj/sphinx 2011-01-04 22:11:57 +01:00
Georg Brandl
4ce378be29 #209: Added :confval:text_newlines and :confval:text_sectionchars config values. 2011-01-04 21:41:05 +01:00
Georg Brandl
442229dd97 Add `pyramid` theme. 2011-01-04 17:49:59 +01:00
Georg Brandl
7beb8533b5 #273: Add an API for adding full-text search support for languages other than English. Add support for Japanese. 
Based on the implementation by SHIBUKAWA Yoshiki in https://bitbucket.org/shibu/sphinx/.
 2011-01-04 12:40:19 +01:00
Georg Brandl
c5b5c16cb3 Fix some broken URLs. 2011-01-04 11:37:56 +01:00
Georg Brandl
17efae5622 merge with 1.0 2011-01-04 11:29:09 +01:00
Georg Brandl
51852c0e87 #472: linkcheck builder: Check links in parallel, use HTTP HEAD requests and allow configuring the timeout. 
New config values: :confval:`linkcheck_timeout` and :confval:`linkcheck_workers`.
 2011-01-04 11:27:42 +01:00