IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity
7,487 Commits 11 Branches 236 Tags
048a35ee54ee62d8ae53acd68a008d4b9afcb457
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Jonathan Waltman 15b34a0940 Set latex_elements['fontpkg'] = '' for Cyrillic languages (suggested by Dmitry Shachnev) 2013-02-22 02:16:02 -06:00
Jonathan Waltman 6294258b0d Add changelog entry for pull request #114. 2013-02-22 01:50:12 -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 c1c9f68099 Merged in klukas/sphinx (pull request #115) 
Add configuration option for transitions in LaTeX output
 2013-02-20 14:58:46 -06:00
Jonathan Waltman 66d799bb00 Closes #1108: [text] Correctly number enumerated lists with non-default start values (based on patch by Ewan Edwards). 2013-02-20 13:50:40 -06:00
Jonathan Waltman 50d4aec15c [texinfo] Update CHANGES and relevant documentation. 2013-02-20 04:09:50 -06:00
Jonathan Waltman 8f74a80216 Really fix seealso labels in manpage writer. 2013-02-20 03:52:27 -06:00
Jonathan Waltman 4f6da6ce8c [texinfo] Do not add the "Index" node when there are no entries. 2013-02-19 20:12:07 -06:00
Jonathan Waltman d95061146f [texinfo] Do not capitalize words in deffn categories containing capital letters. 2013-02-19 19:36:19 -06:00
Jonathan Waltman 3a30bafb28 [texinfo] Render desc_annotation nodes instead of skipping them. 2013-02-19 19:31:48 -06:00
Jonathan Waltman 5078d81755 [texinfo] Change formatting of @strong and @emph in Info output. 
Using strong or emphasis to markup parameter names is quite common and the
default formatting for *strong* and _emph_ often creates confusing output.

They are now formatted like `literals'.
 2013-02-19 17:07:46 -06:00
Jonathan Waltman 9d5aa79078 Fix seealso labels in manpage writer. (broke by commit d9c2da912d3d) 2013-02-19 07:05:19 -06:00
Jonathan Waltman 9dcae72b43 [texinfo] Fix seealso labels. (broke by commit d9c2da912d3d) 2013-02-19 06:58:19 -06:00
Jonathan Waltman 4869e61dff [texinfo] Tweak formatting of field lists. 2013-02-19 06:39:39 -06:00
Jonathan Waltman f033bcd97f [texinfo] Use sphinx.locale.admonitionlabels for admonition nodes. 2013-02-19 05:09:26 -06:00
Jonathan Waltman f8374c9382 [texinfo] Format system messages and problematic nodes like the text builder. 2013-02-19 04:58:52 -06:00
Jonathan Waltman 968b0dd185 [texinfo] Prevent hyphen conversion in option directive signatures. 2013-02-19 04:38:21 -06:00
Jonathan Waltman a18ec10c34 [texinfo] Avoid creating some unnecessary garbage when assembling the final document. 2013-02-19 04:20:13 -06:00
Jonathan Waltman 06359e4d39 [texinfo] Use @finalout and use the default page size for better TeX output. 2013-02-19 04:09:47 -06:00
Jonathan Waltman d5b82a235b [texinfo] Use @ref instead of @pxref for better display of links in non-Info output. 2013-02-19 04:06:08 -06:00
Jonathan Waltman c8d8f69b96 [texinfo] Change formatting of transitions. 2013-02-19 04:03:21 -06:00
Jonathan Waltman 225b85365e [texinfo] Change paragraphindent from 2 to 0. 2013-02-19 04:00:34 -06:00
Jonathan Waltman a37e4d2afd Closes #1074: Add environment version info to the generated search index to avoid compatibility issues. 2013-02-19 03:42: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
Jonathan Waltman 4e87ea0517 Add stub for the keep_warnings config value in quickstart's conf.py 2013-02-19 01:36:46 -06:00
Jonathan Waltman db9cfa4d1a Speed up search index generation by caching word stemming calls. 
Saves about 20 seconds when building the Python documentation.

Here are some stats for building the Python docs on my machine with
and without stem caching.

Without stem caching::

    % rm -fr _build
    % \time sphinx-build -q . _build/html
    158.22user 0.87system 2:39.25elapsed 99%CPU (0avgtext+0avgdata 400800maxresident)k
    104inputs+180240outputs (1major+113472minor)pagefaults 0swaps

    % \time sphinx-build -a -q . _build/html
    91.00user 0.67system 1:31.73elapsed 99%CPU (0avgtext+0avgdata 330704maxresident)k
    0inputs+69864outputs (1major+106009minor)pagefaults 0swaps

With stem caching::

    % rm -fr _build
    % \time sphinx-build -q . _build/html
    137.90user 1.10system 2:20.50elapsed 98%CPU (0avgtext+0avgdata 413344maxresident)k
    18896inputs+180232outputs (1major+113779minor)pagefaults 0swaps

    % \time sphinx-build -a -q . _build/html
    70.04user 0.74system 1:10.87elapsed 99%CPU (0avgtext+0avgdata 345632maxresident)k
    16inputs+69864outputs (1major+108010minor)pagefaults 0swaps
 2013-02-18 21:02:51 -06:00
Jonathan Waltman 4eead33488 Fix local search which was broken by correcting JS issues found by JSHint (commit 46d08152a30d) 2013-01-10 21:58:18 -06:00
Jonathan Waltman e26b02e23e Closes #1070: Avoid un-pickling issues under Python 3 when accessing doctrees saved under Python 2. 2013-01-09 08:58:28 -06:00
Jonathan Waltman 61e951d2ed Closes #1069: Fix autodoc signature formatting of "partial" functions without kwargs (patch by Artur Gaspar). 2013-01-09 08:42:59 -06:00
Jonathan Waltman bba6104b84 Issue #1069: Add failing test for signature formatting of "partial" functions without kwargs. 2013-01-09 08:37:53 -06:00
Jonathan Waltman 69b74303b8 Merged in rolmei/sphinx-epub (pull request #106: Add includehidden option to the toctree directive) 2013-01-07 22:12:03 -06:00
Jonathan Waltman d1a666aef9 Use default values for latex_documents, man_pages, and texinfo_documents if not set in conf.py. 2013-01-07 01:29:53 -06:00
Jonathan Waltman 0ef7a0a7a3 Add missing "meta" and "inline" node visitors for the manpage writer. 2013-01-07 00:33:27 -06:00
Jonathan Waltman 7fd138b588 Avoid AssertionError about losing the "ids" attribute when resolving pending_xrefs created in the CitationReferences transformation. 2013-01-07 00:30:49 -06:00
Jonathan Waltman b98123cd12 Add man_pages config to tests/root/conf.py. 2013-01-06 23:42:25 -06:00
Jonathan Waltman f4a346760c Fix test_man which didn't test if docs were being built. It now successfully fails. 2013-01-06 23:36:33 -06:00
Jonathan Waltman 64a4c13d63 autodoc: Don't rely on reporter.get_source_and_line existing for debug messages. 2013-01-05 21:08:22 -06:00
Jonathan Waltman 268b009017 Move "only" directive tests to a seperate test root. 2013-01-05 20:14:48 -06:00
Jonathan Waltman e55c72218c Merged in rolmei/sphinx-epub (pull request #103: Whitespace cleanup) 2013-01-05 08:48:42 -06:00
Jonathan Waltman 42c90ee178 Add basic debugging support for autodoc. 2013-01-05 08:28:54 -06:00
Jonathan Waltman 51fb8b435b Add verbose option `-v` for sphinx-build and some rudimentary debugging support. 2013-01-05 02:41:12 -06:00
Jonathan Waltman 3cd00a0809 sphinx-build: Provide more specific error messages for invalid arguments. 2013-01-04 22:52:42 -06:00
Jonathan Waltman 66fe7cc2d7 sphinx-build: Support the standard `--help and --version` options. 2013-01-04 22:48:21 -06:00
Jonathan Waltman b338af55df Issue #869: Add option `-T` for printing the full traceback on exception. 2013-01-04 22:24:46 -06:00
Jonathan Waltman cf4166fa58 Fix `test_i18n_literalblock_warning` which would sometimes fail due to the text wrapping of error messages. 2013-01-03 13:55:26 -06:00
Jonathan Waltman d997aa76b0 Closes #958: Do not preserve `environment.pickle` after a failed build. 2013-01-03 13:34:47 -06:00
Jonathan Waltman 29f768e48f Fix minor bugs in test_intl.py causing tests to fail under python 2.5 
os.path.relpath not defined in Python 2.5, use equivalent from
sphinx.util.pycompat

Also avoid trying to create an existing directory when remnants exist
of an earlier failed build
 2012-12-11 01:36:50 -06:00
Jonathan Waltman beae650645 xml: Update sphinx-build documentation 2012-12-10 02:41:12 -06:00
Jonathan Waltman b44376f527 xml: Fix compatibility with docutils<0.9 2012-12-10 02:40:24 -06:00
Jonathan Waltman dbbfdcddcf Merged in pv/sphinx-work/ext-linkcode-fix (pull request #91) 2012-12-07 15:52:17 -06:00
Jonathan Waltman 8ac4aa6282 Add Docutils-native XML and pseudo-XML builders 2012-12-04 21:10:15 -06:00
Jonathan Waltman 1e66d33c7b Add changelog entry for devguide 2012-12-03 01:36:34 -06:00
Jonathan Waltman f65eff4919 Merged in jonwaltman/sphinx-devguide (pull request #88) 2012-12-03 01:26:28 -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
Jonathan Waltman 4e715ff0bf Avoid unknown option warnings for use_2to3 in setup.py under Python 2. 2012-11-11 01:33:52 -06:00
Jonathan Waltman c134b218b7 Closes #681: Allow nested parentheses in C++ signatures (patch by Vadim and Jim Naslund) 2012-11-10 23:37:42 -06:00
Jonathan Waltman 6f9e541ab5 autodoc: Handle explicit instance attributes in :members: (re #904) 2012-11-08 21:19:47 -06:00
Jonathan Waltman 34cbd684a9 Update sys.path to avoid autodoc warnings when building docs in tests/root. 2012-11-08 21:16:41 -06:00
Jonathan Waltman 9d412304cd Remove trailing whitespace. 2012-11-03 12:41:09 -05:00
Jonathan Waltman 025ae13703 setup.py: Update "requires" to docutils>=0.10.0 under Python 3.3 2012-11-03 12:29:55 -05:00
Jonathan Waltman 0e44cb20a1 setup.py: Require Docutils >= 0.10 when running under Python >= 3.3 2012-11-03 11:11:38 -05:00
Jonathan Waltman 55b28b0198 Fix whitespace / line length issues reported by "make test" 2012-11-03 11:04:32 -05:00
Jonathan Waltman e1209ecd90 sphinx-build: Require Docutils >= 0.10 when running under Python >= 3.3 2012-11-03 09:52:39 -05:00
Jonathan Waltman b057ef76ef Require Docutils 0.10 in tox py33 test env. 2012-11-03 09:37:35 -05:00
Jonathan Waltman 2dc47649a2 Update distribute_setup.py to version 0.6.30 (http://python-distribute.org/distribute_setup.py) 2012-11-03 07:35:20 -05:00
Jonathan Waltman ad6318e7f1 Closes #1004: Add default value for docutils setting file_insertion_enabled. 2012-10-02 20:53:40 -05:00
Jonathan Waltman bf362e9ccb Closes #617: Fix docstring preparation without included signature: only ignore indentation of one line, not two. 2012-09-16 01:08:47 -05:00
Jonathan Waltman ead356e3cf Remove note about sectioning limitation of the "only" directive. 2012-09-12 16:40:10 -05:00
Jonathan Waltman 6654687ec1 Closes #886: Fix handling of section headings in "only" directives. 2012-09-12 15:43:27 -05:00
Jonathan Waltman c5405184ba Add failing tests for nested sections in only directives. 2012-09-12 15:34:00 -05:00
Jonathan Waltman 8e96fc71d4 texinfo: Handle duplicate domain indices. 
Reported by Takafumi Arakaki at
https://bitbucket.org/jonwaltman/sphinx-info/issue/1/error-this-node-python-module-index-has
 2012-07-26 06:49:56 -05:00
Jonathan Waltman 1fde44cbf6 Follow the behavior described by :confval:primary_domain to display domain object names and use this as the category in Texinfo desc_signatures. 2011-07-07 01:39:53 -05:00
Jonathan Waltman 626a954821 Use `ObjType.lname` for the category in Texinfo desc_signatures. 2011-07-03 17:44:03 -05:00
Jonathan Waltman d16be40da1 Fix NameError in graphviz.render_dot_texinfo. 2011-06-30 17:21:16 -05:00
Jonathan Waltman a78b9ec927 Prevent indexing commands from causing a paragraph break in Texinfo. 2011-06-29 17:33:27 -05:00
Jonathan Waltman 584dc31883 Replace no-break spaces with normal ones inside desc_parameters for Texinfo. 2011-06-27 19:51:00 -05:00
Jonathan Waltman 10e0fb8ad9 Properly escape ``quote'' characters in Texinfo. 2011-06-27 19:28:47 -05:00
Jonathan Waltman 7147131145 Add method `ensure_eol` and use it to fix paragraph spacing in Texinfo. 2011-06-27 18:45:00 -05:00
Jonathan Waltman 54290ed0e6 Add :confval:texinfo_show_urls. 2011-03-06 00:30:19 -06:00
Jonathan Waltman 20dcad36a3 Add Texinfo support in ext.graphviz, ext.inheritance_diagram and ext.mathbase. 2011-03-05 23:59:34 -06:00
Jonathan Waltman d26bc39ec7 Use the standard Texinfo markup for footnotes. 2011-03-05 18:51:18 -06:00
Jonathan Waltman c8dab4bd8e Add stubs for missing node handlers in Texinfo and remove unnecessary ones. 2011-03-05 18:10:00 -06:00
Jonathan Waltman 68e85d5665 Refactor Texinfo writer; remove `add_text and rstrip` methods. 2011-03-05 17:44:46 -06:00
Jonathan Waltman 924863a602 Handle targets better in Texinfo to avoid bad xrefs. 2011-03-04 19:10:12 -06:00
Jonathan Waltman 2594805b2f Use builder.warn instead of document.reporter.* in Texinfo. 2011-03-04 15:58:59 -06:00
Jonathan Waltman 2f0697ba8e Add contextual information in Texinfo system messages. 2011-03-04 15:35:14 -06:00
Jonathan Waltman b83fb0dd87 Add a standard @copying block in Texinfo. 2011-03-03 23:21:44 -06:00
Jonathan Waltman 883a7fd3cd Merge with https://bitbucket.org/birkenfeld/sphinx 2011-03-02 23:54:27 -06:00
Jonathan Waltman 23bb290c42 Document :confval:texinfo_domain_indices and update quickstart. 2011-02-23 17:55:39 -06:00
Jonathan Waltman edec5818cb Wrap long menu entries in Texinfo. 2011-02-22 16:31:52 -06:00
Jonathan Waltman 83087b4cf6 Generate domain indices in Texinfo. 2011-02-08 01:56:15 -06:00
Jonathan Waltman 9c7e1d2dc2 Don't delete characters that can be escaped in Texinfo. 2011-02-08 00:09:21 -06:00
Jonathan Waltman 9f9c753f7e Mention the texinfo builder in the sphinx-build man page 2011-01-28 02:34:53 -06:00
Jonathan Waltman 1960da0921 Improve how long index entries are formatted in texinfo. 2011-01-28 02:25:15 -06:00
Jonathan Waltman 181aa903f7 Include all nodes in the master menu. 2011-01-28 02:14:34 -06:00
Jonathan Waltman 15c94d6947 Change example code to not use an actual control character. 2011-01-08 21:24:11 -06:00