IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-09 04:28:05 -05:00
Code Issues Packages Projects Releases Wiki Activity
7,959 Commits 11 Branches 236 Tags
f1d4248eea5a481d2cda10f524924f4442e0ca54
Commit Graph
1546 Commits
Author SHA1 Message Date
Takeshi KOMIYA 80bfc55795 Merge branch 'stable' 2016-07-21 00:20:25 +09:00
Takeshi KOMIYA c698fab338 Merge pull request #2786 from shibukawa/fix/epub 
Reduce epub checker warnings/errors for epub3 builder.
 2016-07-20 23:30:59 +09:00
Yoshiki Shibukawa b7b1ac1c4d add preferred instruction to download role description 2016-07-19 23:35:49 +09:00
Yoshiki Shibukawa 702004acfc fix document download roles. download roles works only on html. 2016-07-19 23:15:35 +09:00
Takeshi KOMIYA 1a575f4666 Update CHANGES and docs 2016-07-19 11:03:38 +09:00
Yoshiki Shibukawa 06a861703d Reduce epub checker warnings/errors for epub3 builder. 
Fix DOCTYPE to html5 and change extension from .html to .xhtml.

Sphinx's documents result:

  before: 95 warnings& 1238 errors
  after: 623 errors
 2016-07-17 09:53:04 +09:00
Takeshi KOMIYA 253eef9e6a #2680: sphinx.ext.todo now emits warnings if todo_emit_warnings enabled 2016-07-16 00:59:02 +09:00
Takeshi KOMIYA 2aace8d54b Use jreport to the docclass for Japanese howto documents 2016-07-15 23:34:51 +09:00
Takeshi KOMIYA fc9c9e04ee better default LaTeX settings for Japanese 2016-07-15 22:36:49 +09:00
Ville Skyttä 302c695048 Run *.png through zopflipng -m 
Before: 2334583 bytes
After:  2136324 bytes
 2016-07-07 18:34:18 +03:00
Ville Skyttä f1316a0bb3 Run *.jpg through jpegoptim -s 
Before: 28408 bytes
After:  25206 bytes
 2016-07-07 18:34:18 +03:00
Ville Skyttä 7cfbc2a702 Fix style checks 2016-07-07 16:48:12 +03:00
Takeshi KOMIYA 31c6beb578 Merge pull request #2454 from mgeier/html-sourcelink-txt 
Add option html_sourcelink_suffix
 2016-07-06 01:43:18 +09:00
Rob Ruana 8eecdbd715 [Napoleon] Removes Python 2/3 compatible type annotation doc example, because they aren't current supported by Sphinx 2016-07-02 11:43:55 -04:00
Takeshi KOMIYA e3c3e4f0cb Merge branch 'stable' 2016-07-02 16:39:13 +09:00
jfbu 067d3cabf0 latex, make use of `\small` for code listings customizable 2016-06-30 11:20:30 +02:00
jfbu f30a8d5a36 fix a mark-up typo in doc/install.rst 2016-06-30 11:10:58 +02:00
jfbu a20533540b Add a sentence in doc/config.rst on `'pxunit'` key 2016-06-29 20:55:07 +02:00
jfbu d76e9d48a5 Update doc/rest.rst 2016-06-26 23:13:32 +09:00
jfbu fc2202fd2a latex, replace `'pixelsize' by more precise 'pxunit'` name 2016-06-25 10:32:48 +02:00
jfbu f6b0ae903d latex, allow image dimensions using px unit (96px=1in) 
New key ``'pixelsize'`` in ``latex_elements`` dictionary.
 2016-06-24 20:36:35 +02:00
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