Commit Graph
100 Commits
Author SHA1 Message Date
Georg Brandl 8e4311099a merge with trunk 2010-03-16 08:54:03 +01:00
Georg Brandl a5a08531ee merge with 0.6 2010-03-16 08:53:12 +01:00
Georg Brandl 1ea64352fe A bit more tutorial. 2010-03-14 19:46:54 +01:00
Georg Brandl 79f30848c2 Add link to inline markup spec. 2010-03-14 14:31:45 +01:00
Georg Brandl 1998065b4f Add minimal documentation for the C++ domain. 2010-03-09 19:38:49 +01:00
Georg Brandl c219938a73 Write a bit more of the tutorial. 2010-03-09 19:32:59 +01:00
Georg Brandl 02d6640df3 Update version info for next development. 2010-03-01 23:28:25 +01:00
Georg Brandl 616fbc4ca9 Added tag 0.6.5 for changeset f76fb0be8011 2010-03-01 23:18:42 +01:00
Georg Brandl e9fe355ecd Update version and release date. 2010-03-01 23:12:59 +01:00
Georg Brandl 79e824d96a Add shortcut for SPHINXOPTS. 2010-03-01 22:31:17 +01:00
Georg Brandl 4f2523d17f Mention standard rst roles in inline markup. 2010-03-01 15:01:46 +01:00
Georg Brandl 27d6120528 Fix variable name. 2010-03-01 14:58:36 +01:00
Georg Brandl a479d56b24 Move inline markup description to domains page. 2010-03-01 14:53:30 +01:00
Georg Brandl 3e9182550a Review markup chapter. 2010-03-01 14:37:31 +01:00
Georg Brandl 0f812e72f7 Allow escaping "<" in x-ref roles by a backslash. 2010-03-01 14:36:08 +01:00
Georg Brandl a83f9e7686 Make it clear that the default for "collapse" is True. 2010-02-28 19:54:25 +01:00
Georg Brandl 9334d1537c Add some domain documentation. 2010-03-01 14:22:14 +01:00
Georg Brandl 11bac45b10 More doc. 2010-03-01 11:13:33 +01:00
Georg Brandl 9ebf346c18 Add more visitors for manpage writer. 2010-03-01 10:09:14 +01:00
Georg Brandl 28851d7ea4 Order the tags file by version. 2010-02-28 23:14:46 +01:00
Georg Brandl 0ee675b7cf Update blurb in setup.py and on the index page, link directly to tutorial.rst from index. 2010-02-28 23:12:00 +01:00
Georg Brandl 700c831ae7 Add a bit more info. 2010-02-28 23:03:38 +01:00
Georg Brandl 2cbe10086f Rename tutorial, add example for image substitution. 2010-02-28 23:03:16 +01:00
Georg Brandl 258315fa97 s/highlight/highlighted/ for the search word highlighting class: "highlight" is already used by pygments. 2010-02-28 22:05:19 +01:00
Georg Brandl f36592e418 Begin the Great Refactoring of the docs.
* Move sphinx-build option description from intro to a new document.
* Move toctree information to a new document in markup/.
* Add a tutorial document placed after intro. Begin filling it in.
2010-02-28 22:00:22 +01:00
Georg Brandl 7f1eafb9a3 Re-export docutils .. class:: as .. rst-class:: and un-document .. cssclass::. 2010-02-28 19:30:30 +01:00
Georg Brandl dc84392d22 List all docutils directives with short descriptions and links to the reference. 2010-02-28 17:42:41 +01:00
Georg Brandl 0feb7dacf2 Add a bit more content to the reST primer, and add links to the reST reference docs for all constructs. 2010-02-28 17:24:55 +01:00
Georg Brandl f37588d87f merge with trunk 2010-02-28 15:24:47 +01:00
Georg Brandl 3f1092fcc4 merge with 0.6 2010-02-28 15:21:54 +01:00
Georg Brandl 030f4c451b In autodoc, fix the omission of some module members explicitly documented using documentation comments. 2010-02-28 15:20:11 +01:00
Georg Brandl 6b191b22f1 Port 0f8b5391a6c2 to domains: Fix references to methods without a module. 2010-02-28 14:54:56 +01:00
Georg Brandl 0341cc7c3d Fix references to methods without a module. 2010-02-28 14:54:35 +01:00
Georg Brandl 04f660d021 Change domain-index API: introduce a class. 2010-02-28 14:45:43 +01:00
Georg Brandl 1d5894a35a Fix handling of the default role: it needs to be looked up after patching the role/directive lookup functions. 2010-02-28 14:43:44 +01:00
Georg Brandl 3d01c2c95f #282: Added a "nitpicky" mode that emits warnings for all missing references.
It is activated by the ``-n`` command-line switch or the ``nitpicky`` config value.
2010-02-28 12:13:55 +01:00
Georg Brandl ea8fa8aa02 Fix test_markup. 2010-02-28 12:08:06 +01:00
Georg Brandl a31e7e2f5d #187: Added support for source ordering of members in autodoc, with `autodoc_member_order = 'bysource'`. 2010-02-28 11:39:13 +01:00
Georg Brandl 9a316a21a0 merge with trunk 2010-02-28 10:21:00 +01:00
Georg Brandl 62d092a46c merge with 0.6 2010-02-28 10:20:15 +01:00
Georg Brandl 6661d7214c Fix-up classes for roles without domain. 2010-02-28 10:19:36 +01:00
Georg Brandl b4d03d9ff3 In HTML output, inline roles now get a CSS class with their name,
allowing styles to customize their appearance.  Domain-specific
roles get two classes, ``domain`` and ``domain-rolename``.
2010-02-28 10:17:59 +01:00
Georg Brandl 523b16f005 Revert revision 0530a8aaaa9a; it does not work if dependent files are involved. 2010-02-28 09:49:23 +01:00
Georg Brandl fbc2c113ee #345: Fix cropping of sidebar scroll bar with `stickysidebar`
option of the default theme.
2010-02-28 09:45:28 +01:00
Georg Brandl adca1e02b0 Apply some changes to agogo, contributed by Florian Diesch. 2010-02-28 09:36:27 +01:00
Georg Brandl c2289a17b5 Add missing option_spec for Python domain. 2010-02-28 09:21:24 +01:00
Georg Brandl 452732a0f3 Add Blinker. 2010-02-28 09:19:00 +01:00
Georg Brandl 5d56b325c1 merge 2010-02-27 23:27:16 +01:00
Georg Brandl 036a399011 merge with trunk 2010-02-27 23:14:19 +01:00
Georg Brandl 7612ea864b Add some more docstring content. 2010-02-27 23:14:01 +01:00
Georg Brandl 76eb148770 Add app.override_domain(). 2010-02-27 23:13:51 +01:00
Georg Brandl 27683bcdd7 Remove Python-specific option from general directive. 2010-02-27 23:13:31 +01:00
Georg Brandl 23cec21823 #341: Always generate UNIX newlines in the quickstart Makefile. 2010-02-27 22:54:31 +01:00
Georg Brandl 832e290acd Add "orphan" metadata entry to suppress non-toctree-inclusion warnings. 2010-02-25 22:49:54 +01:00
Georg Brandl 870309d038 Do not emit warnings for images. 2010-02-25 22:49:22 +01:00
Georg Brandl 07a658e50c Remove hand-written manpages, add rst documents to be built with the manpage builder. 2010-02-25 22:22:01 +01:00
Georg Brandl 5c92da1c12 Allow giving no authors. 2010-02-25 22:21:41 +01:00
Georg Brandl 51e8de3446 Update phony target lists. 2010-02-25 22:03:27 +01:00
Georg Brandl ee990c87f5 merge 2010-02-23 21:36:07 +01:00
Georg Brandl b24e6d55e3 #338: Fix running with `-C` under Windows. 2010-02-23 21:35:48 +01:00
Georg Brandl f6260eb6e0 merge 2010-02-23 21:35:31 +01:00
Georg Brandl c8087c5173 Remove tab. 2010-02-23 21:12:18 +01:00
Georg Brandl cee7e4ba3b merge with 0.6 2010-02-21 23:20:26 +01:00
Georg Brandl 686824997d In autodoc, allow customizing the signature of an object via autodoc-process-signature where the built-in mechanism fails. 2010-02-21 22:59:53 +01:00
Georg Brandl fab92b215a Added `autodoc_default_flags` config value, which can be used
to select default flags for all autodoc directives.
2010-02-21 22:16:06 +01:00
Georg Brandl 750c3622fd Add some versionadded tags. 2010-02-21 21:57:58 +01:00
Georg Brandl 94e47ff6d8 merge with trunk 2010-02-21 21:49:54 +01:00
Georg Brandl 1ad03286c0 Add method for adding custom indexes. 2010-02-21 21:49:38 +01:00
Georg Brandl 700dda624e merge with 0.6 2010-02-21 21:48:09 +01:00
Georg Brandl b81b7a0463 Remove docs for autosummary features that are not actually in 0.6. 2010-02-21 21:46:07 +01:00
Georg Brandl a497d65658 Rename arguments and make a few more optional, for convenience. 2010-02-21 15:36:26 +01:00
Georg Brandl 7b86a2f3c2 Use $(BUILDDIR) consistently. 2010-02-21 12:45:43 +01:00
Georg Brandl 94ea515ad7 Fix-up where the ImportError is caught if the manpage writer is missing. 2010-02-21 12:01:27 +01:00
Georg Brandl 5244396781 Fix long line. 2010-02-21 11:54:41 +01:00
Georg Brandl 121b864f31 Add manual page writer. 2010-02-21 11:50:08 +01:00
Georg Brandl d305ab2bd0 Add link to Qt help. 2010-02-20 19:57:13 +01:00
Georg Brandl 93e9221d66 Fix backslash escape. 2010-02-20 19:53:44 +01:00
Georg Brandl b01e689896 Make test work with docutils 0.5. 2010-02-20 19:51:37 +01:00
Georg Brandl 6a17e7d1a6 Make id and reference handling in LaTeX output much more robust, by prefixing the source document name to label names. 2010-02-20 19:47:22 +01:00
Georg Brandl 7f8f3f86b6 Get rid of the "module" node. 2010-02-20 14:45:39 +01:00
Georg Brandl 1b5fbd6fa1 Observe the deprecated *_use_modindex config values. 2010-02-20 14:28:58 +01:00
Georg Brandl ed6562960c Remove "group" identifier from get_index() entries; let the template figure that out. 2010-02-20 14:21:03 +01:00
Georg Brandl 044f61ddb1 Do not throw away existing section ids. 2010-02-20 14:20:39 +01:00
Georg Brandl ea20752386 Remove obsolete hyperref option. 2010-02-20 14:18:48 +01:00
Georg Brandl 454ecf80a4 Make the concept of "module index" generalized to domains. As a side-effect, the latex modindex is no longer generated by LaTeX. 2010-02-20 01:13:23 +01:00
Georg Brandl f440e08ffc Allow empty accesskey to avoid giving an access key. 2010-02-19 23:46:44 +01:00
Georg Brandl b9dd04176f pygments_style for HTML is selected by the theme. 2010-02-19 19:58:35 +01:00
Georg Brandl b2c79111f8 #331: Fix output for enumerated lists with start values in LaTeX. 2010-02-19 10:45:04 +01:00
Georg Brandl 68ecaea045 merge with trunk 2010-02-19 10:36:59 +01:00
Georg Brandl 0c0cde6bd9 merge with http://bitbucket.org/sbarthelemy/sphinx/. 2010-02-19 10:28:32 +01:00
Georg Brandl 3c89a7475b merge with http://bitbucket.org/rolmei/sphinx-epub/. 2010-02-19 10:20:07 +01:00
Georg Brandl f9ba148d85 merge with trunk 2010-02-17 10:49:53 +01:00
Georg Brandl a515165be6 Update Jinja2 requirement. 2010-02-17 10:38:59 +01:00
Georg Brandl 59c3a708a6 merge with 0.6 2010-02-07 23:42:54 +01:00
Georg Brandl 24a5097717 Allow auto-detecting "docs" as sphinx source dir. 2010-02-07 23:40:40 +01:00
Georg Brandl 3d5bb4897f Fix long lines. 2010-01-31 19:33:51 +01:00
Georg Brandl e6aec05812 Add another example site. 2010-01-31 19:28:43 +01:00
Georg Brandl fb046a9a81 Add simuPOP. 2010-01-31 16:51:18 +01:00
Georg Brandl 367a129523 Work a bit on the experimental Cython version of pgen2.parse. 2010-01-31 16:49:20 +01:00
Georg Brandl f93a03a894 Fix rendering of no sidebar at all if html_sidebars entry is []. 2010-01-31 16:47:59 +01:00