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,992 Commits 2 Branches 219 Tags 163 MiB
b8807ed9f9
Commit Graph

164 Commits

Author SHA1 Message Date
Samuel Wright
b3286c6b82 Fix for Issue #1071 2013-10-25 13:08:03 +02:00
Roland Meister
88c72be190 Add warning for unusual chars in filenames. Closes #1199 2013-08-10 15:36:05 +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
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
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
Jonathan Waltman
ead356e3cf Remove note about sectioning limitation of the "only" directive. 2012-09-12 16:40:10 -05: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
2c77c05473 Merge with 1.0 2011-09-23 22:03:34 +02:00
Georg Brandl
ded4bee328 Add note about inclusion with the "include" directive. 2011-09-23 11:22:35 +02:00
Georg Brandl
ad5d9f7c6b Add changelog entry for emphasize-lines and some coding style fixes. 2011-09-22 09:29:36 +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
Georg Brandl
aa0c862d92 Fix typo. 2011-01-08 19:21:34 +01:00
Georg Brandl
8a3598ff8e Cross-reference to role docs. 2011-01-06 20:44:55 +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
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
6c23616b2c merge with 1.0 2011-01-08 20:09:29 +01:00
Georg Brandl
c117b8524f Add link to standard markup description. 2010-09-10 09:05:00 +02:00
Georg Brandl
ab334a2a6f Fix sectioning. 2010-08-23 15:58:26 +00: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
cb26c78079 Describe the "deprecated" directive. 2010-07-29 09:27:46 +02: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
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
3642b521ed merge with 1.0 2011-01-04 00:35:27 +01:00
Daniel Neuhäuser
7f254f1a77 Fixed a typo. Thanks to Thomas Waldmann for finding it. 2010-10-31 13:04:13 +01:00
Georg Brandl
242555d6ca merge with 1.0 2010-09-10 09:09:55 +02:00
Georg Brandl
ad759f54c1 #392: deprecate "centered". 2010-08-26 12:01:12 +00:00
Georg Brandl
40e692e6c3 #504: Add an `index` role, to make inline index entries. 2010-08-25 11:33:30 +00:00
Georg Brandl
2e520e5e7b #460: Allow limiting the depth of section numbers for HTML. 2010-08-25 09:59:53 +00:00
Georg Brandl
0f7072f028 Allow linking to tables just like figures with :ref:. 2010-05-30 12:11:52 +02:00
Georg Brandl
aaa89cbb24 Explain absolute paths in toctree. 2010-05-30 11:58:42 +02:00
Georg Brandl
f6c74a1319 Rename the extlink roles to avoid confusion between :rstdir: and :rst:dir:. 2010-05-24 13:06:55 +02:00
Georg Brandl
9d3e02d238 Add an example. 2010-05-24 13:05:43 +02:00
Georg Brandl
0238e83013 Merge with http://bitbucket.org/tpowers/sphinx/ (rewriting the external/internal distinction code) 
In HTML output, references now get the class ``internal`` if they are internal to the whole project, as opposed to internal to the current page.

The ``menuselection`` and ``guilabel`` roles now support ampersand accelerators.
 2010-05-24 12:57:07 +02:00
Georg Brandl
f4f3066581 Use the new rst domain in the sphinx docs. 2010-04-17 10:39:51 +02:00
Georg Brandl
c219938a73 Write a bit more of the tutorial. 2010-03-09 19:32:59 +01:00
Georg Brandl
4f2523d17f Mention standard rst roles in inline markup. 2010-03-01 15:01:46 +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
9334d1537c Add some domain documentation. 2010-03-01 14:22:14 +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
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
832e290acd Add "orphan" metadata entry to suppress non-toctree-inclusion warnings. 2010-02-25 22:49:54 +01:00
Georg Brandl
538886ab94 A bit of domain documentation. 2010-01-17 19:16:18 +01:00
Georg Brandl
1a7403bed8 Add doc for new doc field syntax. 2010-01-17 19:05:19 +01:00
Georg Brandl
2a2a66a923 merge with trunk 2010-01-08 18:55:35 +01:00
Georg Brandl
c80f52dfbf Added `tab-width option to literalinclude` directive. 2010-01-08 18:36:58 +01:00
Georg Brandl
d12ad380f2 Finish renaming description units to object (description)s. 2009-10-27 19:58:40 +01:00
Georg Brandl
efa4678cfd Add some XXX comments to places where work is needed. 2009-09-08 12:07:11 +02:00
Georg Brandl
3e91b3cd64 merge 2009-09-02 17:32:48 +00:00
Georg Brandl
a734207eea fix markup 2009-08-26 14:30:23 +00:00
Georg Brandl
d3b0d6a105 merge with trunk 2009-08-09 22:46:16 +02:00
Georg Brandl
137f37b2fc merge with 0.6 2009-08-06 23:03:49 +02:00
Georg Brandl
c32186282f #222: Allow the "Footnotes" header to be translated. 2009-08-06 22:48:14 +02:00
Georg Brandl
9fce647b14 merge with 0.6 2009-09-03 18:24:04 +02:00
Georg Brandl
fdf4bf4154 merge with 0.6 2009-06-15 18:36:22 +02:00
Georg Brandl
61a55f095b Remove misguided recommendation to use emphasis for variables. 2009-06-15 17:43:32 +02:00
Georg Brandl
c02b7149aa Move domain-specific code around a bit; builtin domains are now completely in sphinx.domains. Test suite does not pass yet. 2009-07-05 12:24:27 +02:00
Georg Brandl
fb0791bdfc Added the `prepend and append` options to the 
``literalinclude`` directive.
 2009-06-04 17:57:58 +02:00
Georg Brandl
4de4dcccd4 #123: The `glossary directive now supports a :sorted:` 
flag that sorts glossary entries alphabetically.
 2009-03-15 23:34:19 +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
fb511a015a Paths to literal include files and download files can now be absolute too. 2009-02-24 13:38:15 +01:00
Georg Brandl
2f13231fbd merge with 0.5 2009-02-23 19:24:02 +01:00
Georg Brandl
cadb5af9f1 Note that Python code in code blocks is parsed. 2009-02-23 19:23:08 +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
f07d0afef2 Note how to change default role. 2008-12-28 21:29:40 +01:00
Georg Brandl
c49d8217e9 Fix #70: clarify meaning of |today|. 2008-12-15 10:26:07 +01:00
Georg Brandl
21f78a9771 Fix target. 2009-02-15 20:08:31 +01:00
Georg Brandl
106ef21629 More templating docs. 2009-02-15 11:38:23 +01:00
Georg Brandl
aedbdd953d Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +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
9fc2437773 Document new literalinclude options. 2009-01-02 00:32:02 +01:00
Georg Brandl
c80dc58ac1 Rename "object" to "pyobject" and document it. 2008-12-30 15:45:02 +01:00
Georg Brandl
f13c3a00cd Close #23: Added a `classmethod directive along with method` 
and ``staticmethod``.
 2008-12-29 00:11:06 +01:00
Georg Brandl
d271cc57b2 merge 2008-12-28 21:32:12 +01: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
78dec65bcc Due to popular demand, added a `:doc:` role which directly 
links to another document without the need of creating a
label to which a ``:ref:`` could link to.
 2008-12-28 19:44:54 +01:00
Georg Brandl
fb26a2a5fc #14: allow distinct programs for cmdoption directive. 2008-11-09 18:28:36 +01:00
Georg Brandl
7aa1c5eed2 #21: allow short form for seealso arguments. 2008-11-04 21:35:05 +01:00
Georg Brandl
e666b6d203 Correct parameter name in example. 2008-11-04 08:20:18 +01:00
Georg Brandl
3206a6ab6f Add a note about substitutions. 2008-10-25 16:00:53 +00:00
Georg Brandl
a857b89a23 UTF-8 isn't mandatory anymore. 2008-10-16 20:31:28 +00:00
Georg Brandl
47ce40c492 #16: allow referring to figures without explicit text. 2008-09-24 15:36:34 +00:00
Georg Brandl
6a7e6315c2 Commit missing doc change. 2008-09-23 21:27:12 +00:00
Georg Brandl
7d3539c041 Add default highlight language selection support. 
Add support for recognizing Python 3 console output.
 2008-09-09 19:10:09 +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
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
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
e90d6f5f80 Remove the opcode directive. 2008-07-23 15:18:00 +00:00
Georg Brandl
17e7e61778 Merged revisions 64703-64708,64710-64712 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64703 | georg.brandl | 2008-07-04 19:24:00 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix linkcheck builder crash for malformed URLs.
........
  r64704 | georg.brandl | 2008-07-04 19:32:40 +0200 (Fri, 04 Jul 2008) | 2 lines

  Add 0.5 compatibility for more admonitions.
........
  r64705 | georg.brandl | 2008-07-04 19:38:37 +0200 (Fri, 04 Jul 2008) | 2 lines

  Remove silly "rubric" restriction in latex writer.
........
  r64706 | georg.brandl | 2008-07-04 19:41:44 +0200 (Fri, 04 Jul 2008) | 2 lines

  Document rubric:: Footnotes behavior.
........
  r64707 | georg.brandl | 2008-07-04 19:45:28 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix XHTML.
........
  r64708 | georg.brandl | 2008-07-04 19:50:56 +0200 (Fri, 04 Jul 2008) | 2 lines

  More XHTML fixes.
........
  r64710 | georg.brandl | 2008-07-04 19:59:56 +0200 (Fri, 04 Jul 2008) | 2 lines

  Copy the html_logo to the output static dir.
........
  r64711 | georg.brandl | 2008-07-04 20:37:43 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix latex code for module names with underscores that have platforms.
........
  r64712 | georg.brandl | 2008-07-04 20:46:40 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix a crash with nonlocal image URIs.
........
 2008-07-04 18:49:39 +00:00
Georg Brandl
8b0f48a38b Add static method support. 2008-06-23 12:04:56 +00:00
Georg Brandl
1e3b8734fd Add a bit on signatures and field lists. 2008-06-23 11:46:10 +00:00
Georg Brandl
7d4ce97ec3 Add default_role configuration value. 2008-06-17 10:06:37 +00:00
Georg Brandl
bd4166c2d6 Add maxdepth for TOCs. 2008-06-12 21:56:06 +00:00
Georg Brandl
0cf8cc2c5d Provide rest "class" directive as "cssclass". 2008-05-24 19:29:20 +00:00