Commit Graph

4207 Commits

Author SHA1 Message Date
Georg Brandl
5ea87fd6c4 Fix autosummary test suite. 2009-03-16 11:41:35 +01:00
Georg Brandl
9d0a9f3f41 Fix the test suite. 2009-03-16 11:24:19 +01:00
Georg Brandl
e517911ac3 Autodoc can now exclude single members from documentation
via the ``exclude-members`` option.
2009-03-15 23:52:48 +01:00
Georg Brandl
9f12d678aa Fix test. 2009-03-15 19:55:48 +01:00
Georg Brandl
cc8030b074 Fix test_env after update() API change. 2009-03-15 19:04:02 +01:00
Georg Brandl
1861a9ec5d Add autosummary to tests. 2009-03-15 19:02:37 +01:00
Georg Brandl
0d75f37e23 Make WARNING the default warning prefix. 2009-03-05 10:06:18 +01:00
Georg Brandl
51265dfe3f #114: Added an `abbr` role to markup abbreviations and acronyms. 2009-03-05 09:48:55 +01:00
Georg Brandl
b244dbf9b5 Use standard `file:line: warning: message` format for warning messages. 2009-03-05 09:21:35 +01:00
Georg Brandl
fb511a015a Paths to literal include files and download files can now be absolute too. 2009-02-24 13:38:15 +01:00
Georg Brandl
9618b0c78a Add makefile target for easy test coverage checking. 2009-02-22 19:00:36 +01:00
Georg Brandl
7792e27030 #10: implement HTML section numbering. 2009-02-22 15:22:23 +01:00
Georg Brandl
bc9a351853 Fix the serializing and changes builders, and really test them. 2009-02-21 17:17:21 +01:00
Georg Brandl
2ba9ec3456 More generator tests. 2009-02-21 17:16:56 +01:00
Georg Brandl
7073a5bd2c The new `latex_additional_files` config value can be used to
copy files (that Sphinx doesn't copy automatically, e.g. if they
are referenced in custom LaTeX added in ``latex_elements``) to
the build directory.
2009-02-20 11:20:15 +01:00
Georg Brandl
98311e1779 Forgot ifconfig. 2009-02-20 10:45:24 +01:00
Georg Brandl
5b1415d16a Fix #103: add all (usable) builtin extensions to quickstart. 2009-02-20 10:43:56 +01:00
Georg Brandl
a43b651804 Make "make check" happy. 2009-02-19 23:31:34 +01:00
Georg Brandl
bd5eb9f417 Fix a bug in FilenameUniqDict that led to test failures. 2009-02-19 22:36:00 +01:00
Georg Brandl
8bf6fa5a74 Make the HTML xpath tests generator tests. 2009-02-19 22:12:47 +01:00
Georg Brandl
4c81b055c8 Added an `only` directive that can selectively include text
based on enabled "tags".  Tags can be given on the command
line.  Also, the current builder output format (e.g. "html" or
"latex") is always a defined tag.
2009-02-19 21:56:34 +01:00
Georg Brandl
a06813c4ae Test add_description_unit in test suite. 2009-02-18 22:12:03 +01:00
Georg Brandl
6bfed75113 Add more stuff to the autodoc test document, and fix two bugs. 2009-02-18 21:14:14 +01:00
Georg Brandl
298ea6ea5b SVG images are now supported in HTML (via `<object> and <embed>` tags). 2009-02-18 00:52:12 +01:00
Georg Brandl
0b28b3e6f6 Switch copyright and license tags to single style. Add contributor
names in AUTHORS instead, and add the license of etree13 to
LICENSE.
2009-01-03 11:57:07 +01:00
Georg Brandl
058001c831 Fix #68: invalid latex output for images with height set. 2008-12-08 08:52:55 +01:00
Georg Brandl
83dba8fc76 Fix #60: "smart" image inclusion in subdirs. 2008-12-08 08:44:18 +01:00
Georg Brandl
132086798a Fix autoclass_content = "both" bug. 2008-12-07 22:36:23 +01:00
Georg Brandl
35a58e50ca Also fix invalid index entries for Latex output. 2008-11-30 21:06:07 +01:00
Georg Brandl
4b2864e87c Add a test for a new documenter. 2009-02-18 00:06:24 +01:00
Georg Brandl
b42e9303f4 Update the test_autodoc for the autodoc refactorings and fix a few remaining bugs. 2009-02-17 23:55:05 +01:00
Georg Brandl
c3e13cfa9a Add theming test suite, fix a few bugs and doc problems. 2009-02-15 16:10:10 +01:00
Georg Brandl
f48c9a6595 Fix test suite. 2009-02-15 12:44:10 +01:00
Georg Brandl
1219e3e73a merge with main 2009-02-14 23:25:30 +01:00
Georg Brandl
fc7249e74a Add missing file. 2009-02-14 19:48:07 +01:00
Georg Brandl
06b32a712f Image paths can now be absolute (like `/images/foo.png`).
They are treated as relative to the top source directory.
2009-02-14 15:29:18 +01:00
Georg Brandl
26ae3f01aa Add a rst_epilog setting, usable for global substitutions. 2009-02-07 19:41:10 +01:00
Georg Brandl
1e347aba51 Skip pygments-related tests if it is not installed. 2009-02-06 22:18:16 +01:00
Georg Brandl
d1e6119461 merge with trunk 2009-01-26 22:44:38 +01:00
Georg Brandl
f1e39097c6 Add a minimal test for external toctree links and fix a small bug found by it. 2009-01-26 22:04:29 +01:00
Georg Brandl
7b08f9ecbd Clean up tests conf.py, no need to include comments. 2009-01-10 22:32:54 +01:00
Georg Brandl
aedbdd953d Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +01:00
Benjamin Peterson
07c5a8b449 use the py3k version of callable() 2009-01-10 13:04:23 -06:00
Georg Brandl
a759690221 merge in Murkt's branch 2009-01-04 22:33:00 +01:00
Georg Brandl
c83d630fd8 Close #52: There is now a `hlist` directive, creating a compact
list by placing distributing items into multiple columns.
2009-01-04 22:00:40 +01:00
Georg Brandl
04689accd0 Small API change. 2009-01-04 20:43:15 +01:00
Georg Brandl
27bc4e3189 Add new tests for the attribute feature and fix existing tests. 2009-01-04 20:27:37 +01:00
Georg Brandl
b4a866e2fb merge with main 2009-01-03 12:35:15 +01:00
Georg Brandl
4d083fabbe Add tests for new literalinclude options, and fix an off-by-one bug. 2009-01-03 12:29:42 +01:00
Georg Brandl
f16f94f2cd Merge in copyright style changes from 0.5. 2009-01-03 12:15:19 +01:00
Benjamin Peterson
bb6b7d9b31 add a test for detecting python console sessions 2009-01-01 10:33:41 -06:00
Georg Brandl
b3d55c3139 Close #4: Added a `:download:` role that marks a non-document file
for inclusion into the HTML output and links to it.
2008-12-28 21:30:25 +01:00
Georg Brandl
a2363c0751 Fix test_autodoc after return annotation change. 2008-12-28 19:44:10 +01:00
Georg Brandl
26d7aafaae Explicitly refer to the license in :license: tags. 2008-12-27 12:19:17 +01:00
Georg Brandl
0a1b821c7f Handle class aliases (like `class Foo: factory = dict`) better in autodoc. 2008-12-25 21:50:45 +01:00
Georg Brandl
dafb55a467 Fix documentation of inner classes in autodoc. Messy! 2008-12-23 20:05:56 +01:00
Georg Brandl
409cc1fe39 Remove sphinx.builder usage. 2008-12-23 20:04:45 +01:00
Georg Brandl
037954d850 The `autodoc_skip_member` event now also gets to decide
whether to skip members whose name starts with underscores.
Previously, these members were always automatically skipped.
Therefore, if you handle this event, add something like this
to your event handler to restore the old behavior::

   if name.startswith('_'):
       return True
2008-12-15 12:49:40 +01:00
Georg Brandl
1d00f4a487 Merge bugfix from 0.5. 2008-12-08 08:57:46 +01:00
Georg Brandl
9442b92213 Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-08 08:44:34 +01:00
Georg Brandl
733b2b5bc6 Automated merge with file:///home/gbr/devel/sphinx0.5 2008-12-07 22:36:44 +01:00
Georg Brandl
4634b296af Merge bugfix from 0.5. 2008-11-30 21:09:28 +01:00
Georg Brandl
c450bab147 Allow using different Pygments formatters. 2008-11-30 20:29:34 +01:00
Georg Brandl
50339493c6 Add Sphinx.add_lexer(). 2008-11-30 19:58:29 +01:00
Georg Brandl
2757866655 Allow giving values for dict type config values in the overrides. 2008-11-30 16:33:56 +01:00
Georg Brandl
9175e665b1 Move builders and writers into new packages. 2008-11-29 19:56:58 +01:00
Georg Brandl
6726192fb6 Don't fail test suite because of missing latex packages. 2008-11-23 21:58:30 +01:00
Georg Brandl
a2773de9e0 Add file in _static directory so that it isn't ignored by Hg. 2008-11-23 21:35:52 +01:00
Georg Brandl
2bb2e78488 2.4 compatibility fix. 2008-11-23 19:02:10 +01:00
Georg Brandl
91c31181b0 Add tests for HTML escaping. 2008-11-23 15:22:09 +01:00
Georg Brandl
410ac72590 Fix test after latex writer change. 2008-11-23 15:21:57 +01:00
Georg Brandl
4c3f2f0d7e Add classes to toctree items that indicate depth. 2008-11-09 20:43:36 +01:00
Georg Brandl
0060e50efa Add todo extension. 2008-11-09 19:46:32 +01:00
Georg Brandl
6935790e0f Fix test typo. 2008-11-08 12:26:49 +01:00
Georg Brandl
dbfe74d5e6 Fix the handling of images in different directories. 2008-11-06 10:36:56 +01:00
Georg Brandl
7aa1c5eed2 #21: allow short form for seealso arguments. 2008-11-04 21:35:05 +01:00
Georg Brandl
a6f09758e3 Add -A option to pass values into HTML templates. 2008-11-04 08:34:35 +01:00
Georg Brandl
324145853e #29: fix some option list issues, in HTML, LaTeX and text writers. 2008-11-03 21:40:21 +01:00
Georg Brandl
1ed2d916cd Improve node coverage for latex/text writers. 2008-11-01 14:40:02 +00:00
Georg Brandl
2ebb04f10f Fix for r67038. 2008-10-28 16:53:05 +00:00
Georg Brandl
fb58083eb5 Remove outdated check. 2008-10-27 17:36:19 +00:00
Georg Brandl
29a3a86cef Add global citations. #1. 2008-10-25 15:54:34 +00:00
Georg Brandl
9f4be9b916 Add minimal test for descitems. 2008-10-18 17:57:35 +00:00
Georg Brandl
3a1af61b9f Add test for meta directive and add visitor functions for latex and text writers. 2008-10-18 17:29:56 +00:00
Georg Brandl
8ccd4ace64 Role names are case-insensitive. #24. 2008-10-16 20:41:05 +00:00
Georg Brandl
688ef9dc1f Properly escape authors and titles put into quickstart latex_documents setting. 2008-10-16 19:43:15 +00:00
Georg Brandl
2f392028cf Adapt markup test to renaming of highlighting escapes. 2008-09-16 07:52:19 +00:00
Georg Brandl
afa63e57d8 Add test for coverage builder and fix an AttributeError in it. 2008-09-13 09:45:59 +00:00
Georg Brandl
063283a1be Add missing file. 2008-09-13 09:44:40 +00:00
Georg Brandl
e943dca703 A bit more testing for autodoc. 2008-09-12 15:46:19 +00:00
Georg Brandl
703acbfe57 Fix nits. 2008-09-11 22:14:34 +00:00
Georg Brandl
7679af3ae4 Fix handling of __all__ for modules and add a test. 2008-09-06 20:11:04 +00:00
Georg Brandl
f0605a40a4 Merged revisions 65640,65675,65699,65701 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65640 | georg.brandl | 2008-08-11 16:11:17 +0200 (Mon, 11 Aug 2008) | 2 lines

  More info in intro.
........
  r65675 | georg.brandl | 2008-08-14 13:53:02 +0200 (Thu, 14 Aug 2008) | 2 lines

  #3546: add missing linebreak.
........
  r65699 | benjamin.peterson | 2008-08-15 23:02:22 +0200 (Fri, 15 Aug 2008) | 4 lines

  rename util.with_testapp to util.with_app; nose was running it

  also make an assert more informative
........
  r65701 | benjamin.peterson | 2008-08-16 00:00:54 +0200 (Sat, 16 Aug 2008) | 1 line

  add some tests for sphinx.application
........
2008-08-23 15:04:45 +00:00
Georg Brandl
b3f1de1bf7 New config value "keep_warnings", default is to discard the from the saved doctrees. 2008-08-10 17:10:31 +00:00
Georg Brandl
e93af0e57c Merged revisions 65566-65567,65623,65625 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65566 | georg.brandl | 2008-08-07 09:11:11 +0000 (Thu, 07 Aug 2008) | 2 lines

  Clarification for the ref role.
........
  r65567 | georg.brandl | 2008-08-07 09:11:25 +0000 (Thu, 07 Aug 2008) | 2 lines

  Rebuild everything if extensions change.
........
  r65623 | georg.brandl | 2008-08-10 11:18:42 +0000 (Sun, 10 Aug 2008) | 2 lines

  Unify handling of LaTeX escaping, and add some more replacements.
........
  r65625 | georg.brandl | 2008-08-10 11:25:41 +0000 (Sun, 10 Aug 2008) | 2 lines

  Make tex escapes a module.
........
2008-08-10 16:59:27 +00:00
Georg Brandl
74d36acbf7 * Add more generated text to the automatic translation.
* Remove all locale-dependent text from sphinx.sty, put it into Python files
  to enable message extraction and translation.
* Use babel in the LaTeX output.
* Centralize locations for labels used in every builder.
2008-08-10 10:00:20 +00:00
Georg Brandl
3204f83dc7 Merged revisions 65556 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65556 | georg.brandl | 2008-08-06 15:12:43 +0000 (Wed, 06 Aug 2008) | 2 lines

  Run latex over the latex builder's output.
........
2008-08-06 15:13:42 +00:00
Georg Brandl
6d89feae1e Test suite update for math extension. 2008-08-06 14:57:44 +00:00
Georg Brandl
26d724cb6d Merged revisions 65532,65546-65547,65550-65551 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65532 | georg.brandl | 2008-08-04 22:35:07 +0000 (Mon, 04 Aug 2008) | 2 lines

  Add a test file for misc. markup and fix a doc bug.
........
  r65546 | georg.brandl | 2008-08-05 09:55:20 +0000 (Tue, 05 Aug 2008) | 2 lines

  Show an indication while downloading the search index.
........
  r65547 | georg.brandl | 2008-08-05 10:07:50 +0000 (Tue, 05 Aug 2008) | 2 lines

  Fix an indentation problem in production lists. #3477.
........
  r65550 | georg.brandl | 2008-08-05 16:21:34 +0000 (Tue, 05 Aug 2008) | 2 lines

  Remove unused interface.js.
........
  r65551 | georg.brandl | 2008-08-06 08:48:21 +0000 (Wed, 06 Aug 2008) | 2 lines

  Don't try to remove a nonexisting static dir.
........
2008-08-06 14:46:11 +00:00
Georg Brandl
432115123e Merged revisions 65529 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65529 | georg.brandl | 2008-08-04 22:19:30 +0000 (Mon, 04 Aug 2008) | 6 lines

  Revert r65499 which was not well thought out. Instead, put
  the whole build dir in exclude_trees by default in quickstart.

  Also, revisit application cleanup and make it consistently use
  less setup time while still trying to leave to traces.
........
2008-08-04 22:20:44 +00:00
Georg Brandl
0a15003d0c Merged revisions 65498-65499,65526 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65498 | georg.brandl | 2008-08-04 17:07:33 +0000 (Mon, 04 Aug 2008) | 2 lines

  Absolutize doctreedir when parsing from commandline.
........
  r65499 | georg.brandl | 2008-08-04 17:17:49 +0000 (Mon, 04 Aug 2008) | 4 lines

  If output and/or doctree directory are within the source directory,
  except them from the search for source files.
........
  r65526 | georg.brandl | 2008-08-04 21:46:41 +0000 (Mon, 04 Aug 2008) | 2 lines

  Let the test suite run the text, linkcheck, and changes builders.
........
2008-08-04 21:48:12 +00:00
Georg Brandl
03b12e5d85 Add tests for between() and cut_lines() and fix them.
Also fix a bug in the application interface.
2008-08-04 20:16:18 +00:00
Georg Brandl
00b30f6f65 Add a test suite for autodoc. 2008-08-04 19:39:05 +00:00
Georg Brandl
b4f71aa642 Merged revisions 65283,65303,65316-65317,65372-65375,65377,65380,65483-65485,65494 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65283 | georg.brandl | 2008-07-29 10:07:26 +0000 (Tue, 29 Jul 2008) | 2 lines

  Update ez_setup.py.
........
  r65303 | benjamin.peterson | 2008-07-30 12:35:34 +0000 (Wed, 30 Jul 2008) | 1 line

  add a with_testapp decorator for test functions that passes the TestApp instance in a cleans up after it
........
  r65316 | benjamin.peterson | 2008-07-30 23:12:07 +0000 (Wed, 30 Jul 2008) | 1 line

  make the app for test_markup global to the module
........
  r65317 | benjamin.peterson | 2008-07-30 23:31:29 +0000 (Wed, 30 Jul 2008) | 1 line

  make TestApp.cleanup more aggressive
........
  r65372 | georg.brandl | 2008-08-01 19:11:22 +0000 (Fri, 01 Aug 2008) | 2 lines

  Add more tests, fix a few bugs in image handling.
........
  r65373 | georg.brandl | 2008-08-01 19:28:33 +0000 (Fri, 01 Aug 2008) | 2 lines

  Fix oversight.
........
  r65374 | benjamin.peterson | 2008-08-01 19:36:32 +0000 (Fri, 01 Aug 2008) | 1 line

  fix one broken test
........
  r65375 | georg.brandl | 2008-08-01 19:41:11 +0000 (Fri, 01 Aug 2008) | 2 lines

  Fix the handling of non-ASCII input in quickstart.
........
  r65377 | georg.brandl | 2008-08-01 19:48:24 +0000 (Fri, 01 Aug 2008) | 2 lines

  Allow REs in markup checks.
........
  r65380 | georg.brandl | 2008-08-01 20:31:18 +0000 (Fri, 01 Aug 2008) | 2 lines

  Don't rely on mtimes being different for changed files.
........
  r65483 | georg.brandl | 2008-08-04 09:01:40 +0000 (Mon, 04 Aug 2008) | 4 lines

  Add an "encoding" option to literalinclude.

  Add tests for include directives.
........
  r65484 | georg.brandl | 2008-08-04 09:11:17 +0000 (Mon, 04 Aug 2008) | 2 lines

  Add changelog entry.
........
  r65485 | georg.brandl | 2008-08-04 09:21:58 +0000 (Mon, 04 Aug 2008) | 2 lines

  Fix markup.
........
  r65494 | georg.brandl | 2008-08-04 16:34:59 +0000 (Mon, 04 Aug 2008) | 2 lines

  Correctly use HTML file suffix in templates.
........
2008-08-04 17:01:15 +00:00
Georg Brandl
6c2f991be0 Merged revisions 65138,65145-65146,65268-65273 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r65138 | georg.brandl | 2008-07-19 15:42:35 +0200 (Sat, 19 Jul 2008) | 2 lines

  #3416: fix missing parameter.
........
  r65145 | georg.brandl | 2008-07-19 20:01:25 +0200 (Sat, 19 Jul 2008) | 2 lines

  Now that we don't ship Jinja anymore by default the comment can go.
........
  r65146 | georg.brandl | 2008-07-19 20:01:51 +0200 (Sat, 19 Jul 2008) | 2 lines

  Reread documents with globbed toctrees when files are removed/added.
........
  r65268 | georg.brandl | 2008-07-29 10:21:33 +0200 (Tue, 29 Jul 2008) | 2 lines

  Fix by Markus Gritsch to place correct links to headings.
........
  r65269 | georg.brandl | 2008-07-29 10:21:59 +0200 (Tue, 29 Jul 2008) | 2 lines

  Make the writer's settings public.
........
  r65270 | georg.brandl | 2008-07-29 10:22:28 +0200 (Tue, 29 Jul 2008) | 2 lines

  Export test_root.
........
  r65271 | georg.brandl | 2008-07-29 10:22:47 +0200 (Tue, 29 Jul 2008) | 2 lines

  Add a markup test.
........
  r65272 | georg.brandl | 2008-07-29 10:27:19 +0200 (Tue, 29 Jul 2008) | 2 lines

  Bump version number.
........
  r65273 | georg.brandl | 2008-07-29 11:05:37 +0200 (Tue, 29 Jul 2008) | 2 lines

  Correct rendering of ``samp``.
........
2008-07-29 09:07:37 +00:00
Georg Brandl
ae2570c269 Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64808 | georg.brandl | 2008-07-08 21:39:33 +0200 (Tue, 08 Jul 2008) | 2 lines

  Allow relocation of source and doctree dir.
........
  r65013 | georg.brandl | 2008-07-16 15:25:30 +0200 (Wed, 16 Jul 2008) | 2 lines

  Remove curious quote.
........
  r65076 | georg.brandl | 2008-07-17 22:43:01 +0200 (Thu, 17 Jul 2008) | 2 lines

  Add a test for sphinx.quickstart.
........
  r65100 | georg.brandl | 2008-07-18 14:41:54 +0200 (Fri, 18 Jul 2008) | 2 lines

  Fix phony targets.
........
  r65101 | georg.brandl | 2008-07-18 14:55:03 +0200 (Fri, 18 Jul 2008) | 2 lines

  Fix problems in "make check".
........
  r65119 | georg.brandl | 2008-07-18 23:06:42 +0200 (Fri, 18 Jul 2008) | 2 lines

  Emit a more precise error message in autodoc.
........
  r65121 | georg.brandl | 2008-07-18 23:41:35 +0200 (Fri, 18 Jul 2008) | 2 lines

  Warn if a toctree-included document doesn't contain a title.
........
  r65122 | georg.brandl | 2008-07-18 23:51:28 +0200 (Fri, 18 Jul 2008) | 2 lines

  Don't use \samp{} for code with whitespaces, only for :samp:`code`.
........
  r65123 | georg.brandl | 2008-07-19 00:49:46 +0200 (Sat, 19 Jul 2008) | 2 lines

  Put inheritance info always on its own line.
........
2008-07-18 22:55:36 +00:00
Georg Brandl
f4d5c0a380 Add a test suite skeleton, a first test for sphinx.config, and fix a bug in config. 2008-06-05 08:58:43 +00:00