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
7,572 Commits 2 Branches 219 Tags
baaef9146d46e772a680ecfe3d16e51806890156
Commit Graph

1475 Commits

Author SHA1 Message Date
Rob Ruana
2b60fc2027 Fixes #2688: [Napoleon] Updates to Napoleon documentation to fix intersphinx links and demonstrate PEP 484 type annotations 2016-06-23 15:25:46 -04:00
jfbu
5bd76815ff Added an item about sphinxVerbatim to doc/latex.rst 2016-06-22 22:30:58 +02:00
jfbu
12ade10d55 New latex.rst for extended documentation of LaTeX's customizing. 2016-06-20 09:23:41 +02:00
jfbu
2cec5a25b2 Merge branch 'stable' 
Conflicts:
	sphinx/domains/cpp.py
	sphinx/texinputs/sphinx.sty
	tests/test_build_latex.py
 2016-06-15 18:29:58 +02:00
jfbu
5510653d6e Fix #2629. Add new config option `latex_keep_old_macro_names` 
The cause of the issue was a clash about ``\titleref`` macro being already
defined in memoir class context. To avoid similar problems, this makes
the text styling macros

  ``\strong``, ``\code``, ``\bfcode``, ``\email``, ``\tablecontinued``,
  ``\titleref``, ``\menuselection``, ``\accelerator``, ``\crossref``,
  ``\termref``, ``\optional``,

also available with ``\sphinx`` prefix, with a conf.py boolean option to
let sphinx.sty only define ``\sphinx``-prefixed macros. As default value
is False, backwards compatibility is maintained.

On this occasion, some internal non-public macros have been renamed with
prefix ``\spx@``. The command

    find . -name '*.sty' -exec grep -l \\\\spx@ {} \;

has been executed in TeXLive 2015 and 2016 installations to check no
package defines macros starting with ``\spx@``.

Some internal macros having public names (because they are written by
latex.py into the body of the latex document) have been renamed to have
``\sphinx`` prefix. The macros in sphinx.sty starting with \py@, or \DU,
or \PYG have not been modified. Similarly ``\release``, ``\version``,
``\releasename``, etc... have not been renamed.
 2016-06-15 08:53:24 +02:00
Rob Ruana
ff34d02beb Fix #2537: [Napoleon] Corrects minor formatting issue on example NumPy Attributes section 2016-06-12 14:55:39 -06:00
Rob Ruana
32a852c1f1 Update #2374: [Napoleon] clarifies documentation of napoleon_include_init_with_doc conf value 2016-06-11 18:28:48 -06:00
Takeshi KOMIYA
a35399a0aa Merge branch 'stable' 2016-06-10 20:55:05 +09:00
jfbu
7d3bddd4e3 Convert text into links at bottom of tutorial.rst and top of config.rst 2016-06-09 15:34:59 +02:00
jfbu
c51282530c Merge branch 'stable' 2016-06-08 11:38:33 +02:00
Matthias Geier
5559150578 Change html_sourcelink_txt -> html_sourcelink_suffix 2016-06-07 15:17:12 +02:00
Matthias Geier
86615e1f09 Add option html_sourcelink_txt 2016-06-07 15:15:39 +02:00
jfbu
f38665b58c Display correctly the Builtin themes in the PDF build of Sphinx doc 
Add longtable as class, which will allow pagebreaks in pdf output.
 2016-06-06 14:42:58 +02:00
Takeshi KOMIYA
f6ebd372d4 Merge branch 'stable' 2016-06-05 17:24:41 +09:00
Takeshi KOMIYA
7661a92fc1 Update docs; the inputenc hack will be released at 1.4.3 2016-05-31 10:07:03 +09:00
Avram Lubkin
197b33816f Only add '\\usepackage[utf8]{inputenc}' when using pdflatex 2016-05-31 10:02:58 +09:00
Jakob Lykke Andersen
8a64cfdd91 C++, add support for template introductions. 
Thanks to mickk-on-cpp.
 2016-05-30 23:18:10 +09:00
Jakob Lykke Andersen
74191207db C++, add support for concept declarations. 
Concept placeholders are automatically linked.
Thanks to mickk-on-cpp.
 2016-05-30 19:45:17 +09:00
Takeshi KOMIYA
e01d5d8507 Merge pull request #2590 from avylove/inputenc 2016-05-29 09:24:47 +09:00
Avram Lubkin
786f31eb57 Only add '\\usepackage[utf8]{inputenc}' when using pdflatex 2016-05-28 13:26:45 -04:00
Takeshi KOMIYA
1d17475a08 #2575: Now `sphinx.ext.graphviz allows :align:` option 2016-05-28 18:29:10 +09:00
Takeshi KOMIYA
e3be266be3 Merge branch 'stable' 2016-05-28 17:29:43 +09:00
Takeshi KOMIYA
98c27003d0 Update description of numref option (ref: #2384) 2016-05-27 23:40:01 +09:00
miyakogi
0c89808112 Sphinx.add_source_parser takes only two arguments 
https://github.com/sphinx-doc/sphinx/blob/master/sphinx/application.py#L794
 2016-05-27 23:32:29 +09:00
Takeshi KOMIYA
2578f47664 Merge branch 'stable' 2016-05-26 20:55:26 +09:00
Takeshi KOMIYA
c9296ba467 Merge branch 'stable' 2016-05-09 10:11:13 +09:00
barbara-sfx
2038932b83 Add info on inline web link syntax 2016-05-06 09:13:48 -07:00
John L. Villalovos
ca49c4c207 Add a 'reverse' flag option to 'toctree' 
I'm not sure the best way to do the unit tests. A little confused. So
help would be appreciated :)

Add the ability to reverse the list of entries when using 'toctree'.
This is likely most useful for people using the 'glob' flag option with
'toctree'

Change-Id: I1852479106c3d9c8253fd1625ced0077af0304e3
 2016-05-04 17:34:20 -07:00
nevimov
0960f0d9f2 Split doctest extension docs into sections 
At the moment the docs have no sections at all. This commit adds
sections "Directives" and "Configuration" to facilitate navigation.
Also, it removes the outdated line about the number of directives
provided by the extension (there’s now 5 of them).
 2016-05-02 02:02:55 +07:00
nevimov
7ead796168 Fix code example in "HTML theming support" docs 
- replaces invalid js-style comments with valid python
- shortens the comments so they don't need l10n
 2016-04-26 19:14:53 +07:00
Takeshi KOMIYA
e3def45ffe Use locales as a default value of locale_dirs 2016-04-25 22:25:58 +09:00
Takeshi KOMIYA
59c40c24f3 Add warning for Application.add_source_parser() 2016-04-24 13:57:32 +09:00
Takeshi KOMIYA
52c7867d14 Fix #2466: Allow image.data_uri and image.nonlocal_uri as confval of suppress_warnings 2016-04-22 11:14:46 +09:00
taschini
80bbdd4998 Reformatted doc for doctest_default_flags (#2471). 2016-04-21 14:17:43 +02:00
taschini
604b45d44b Incorporated feeback on doc for doctest_default_flags (#2471). 2016-04-21 12:35:36 +02:00
taschini
8c1d9cc71c Documenting doctest_default_flags config variable (#2471). 2016-04-21 12:07:00 +02:00
shimizukawa
132059a253 merge with stable 2016-04-18 14:41:06 +09:00
shimizukawa
d5c36e045b update devguide: following current procedure to run test 2016-04-18 14:36:25 +09:00
Takeshi KOMIYA
21ee53df2d Define new warning types for suppress_warnings (ref #2451) 2016-04-16 12:43:03 +09:00
Takeshi KOMIYA
174e61fdb2 Merge branch 'stable' 2016-04-06 21:22:04 +09:00
Robert Lehmann
ca900593c0 Clear up Pygments is mandatory 
While Pygments is not required for other builders, it is *always* used in the HTML builder.
 2016-04-05 11:32:16 +02:00
Takeshi KOMIYA
d35ccb9b4c The default format of today_fmt and html_last_updated_fmt is back to strftime format again 
`html_last_updated_fmt` is commonly used for non date formatting. But
LDML is difficult to represent them from its characteristics.

Now we moved to strftime format again (ref: #2394).
 2016-04-03 10:25:32 +09:00
jfinkels
2437afca33 Corrects sentence describing 'default' theme 2016-04-02 13:39:32 -04:00
Jakob Lykke Andersen
c6ba3093fe C++, make prefixes of type declarations better. 
Type declarations are now using the prefixes ``typedef``, ``using``, and ``type``,
depending on the style of declaration.
See also michaeljones/breathe#243 and michaeljones/breathe#242.
 2016-03-30 16:55:02 +09:00
Jan Duzinkiewicz
d8cd3ec4be fix #2379 - Keyword args rendered with type links, as normal parameters (configurable under napoleon_use_keyword option) 2016-03-23 19:30:14 +01:00
Eric Holscher
7acf202842 Clean up the prose on the main site page 2016-03-15 10:53:20 -07:00
Takeshi KOMIYA
d86ea47b52 Add `:caption:` option for sphinx.ext.inheritance_diagram 2016-03-11 13:20:05 +09:00
Takeshi KOMIYA
da94ca5699 Merge branch '2327_toplevel_sectioning' 2016-03-03 20:41:17 +09:00
Takeshi KOMIYA
3939c4d684 Merge branch '2229_suppress_warnings' 2016-03-03 20:40:38 +09:00
Takeshi KOMIYA
110c2b0dbc Fix #2327: Add latex_toplevel_sectioning to switch the top level sectioning of LaTeX document. 2016-03-02 11:18:08 +09:00