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
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
Georg Brandl
3642b521ed merge with 1.0 2011-01-04 00:35:27 +01:00
Georg Brandl
a304c8d247 Fix-up half-sentence. 2011-01-03 23:50:30 +01:00