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
21,707 Commits 2 Branches 219 Tags 163 MiB
daade2715a
Commit Graph

236 Commits

Author SHA1 Message Date
Jon Dufresne
bade33c7e4 Remove unnecessary encoding cookie from Python source files 
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
 2018-12-16 12:22:12 -08:00
Takeshi KOMIYA
4761e70c37 Merge branch '1.8' 2018-11-22 22:14:32 +09:00
jfbu
1edf2a45b9 LaTeX: font choices for Greek and Cyrillic support, and (Xe|Lua)LaTeX 2018-11-21 22:21:02 +01:00
jfbu
2825e338c2 LaTeX: support for Greek and Cyrillic 
0. do not escape Unicode Greek letters via LaTeX math mark-up: pass them
   through un-modified to LaTeX document,

1. if "fontenc" receives extra option LGR, then pdflatex will support
   Unicode Greek letters (not in math), and with extra option T2A it
   will support (most) Unicode Cyrillic letters.

2. for pdflatex with LGR, this will use "textalpha" LaTeX package and
   "substitutefont" package to set up some automatic font substitution
   to work around the unavailability of Greek with "times"
   package (which is default font package chosen by Sphinx for
   pdflatex), same with T2A and "substitutefont" for Cyrillic.

3. for xelatex/lualatex, set up Computer Modern Unicode as default font,
   as it supports Cyrillic and Greek scripts,

4. for platex, don't do anything special as the engine already has
   its default font supporting Cyrillic and Greek (even in math mode!)

Closes: #5251
Fixes:  #5248
Fixes:  #5247
 2018-11-16 21:14:51 +01:00
Dmitry Shachnev
2a9cad7b2e Move language-specific data into a new JS file, language_data.js 
This file is included in script_files, so it will be present even for
projects using custom templates.

Fixes #5460.
 2018-11-04 12:13:07 +03:00
Takeshi KOMIYA
a912d90440 doc: app.info() should allow keyword argument 2018-09-20 20:32:41 +09:00
Takeshi KOMIYA
48d4a52276 doc: Update workaround for RTD 2018-09-20 20:29:56 +09:00
Takeshi KOMIYA
a4843cab2c Fix typo 2018-09-20 20:27:25 +09:00
Takeshi KOMIYA
134bcde40b Add workaround for RTD (refs: #5461) 2018-09-20 20:17:21 +09:00
jfbu
f0067f4a04 Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD" 
This reverts commit 9b2aac68ea.
 2018-07-31 10:46:48 +02:00
Jean-François B
54456ba455
Merge branch 'master' into 3742_index_in_PDF_bookmark_at_RTD 2018-07-16 17:15:45 +02:00
jfbu
9b2aac68ea LaTeX: extend to all projects the #3742 fix for PDF builds at RTD 
Refs: https://github.com/rtfd/readthedocs.org/issues/2857
 2018-07-15 15:24:25 +02:00
jfbu
7b44adb048 Use xindy for Sphinx's own PDF documentation 
Makeindex gathered under heading "Symbols" all command line options,
this seems less satisfactory than index produced by xindy.
 2018-07-14 19:15:33 +02:00
Jon Dufresne
2f17a0e8c8 Update Python 2 doc links to Python 3 
Python 3 docs are more actively maintained and are the future.
 2018-06-09 20:59:43 -07:00
Takeshi KOMIYA
69624bffa7 doc: Fix filename 2018-04-12 00:49:31 +09:00
jfbu
bfdf0d1e83 Merge branch '1.7' 2018-03-30 22:50:55 +02:00
jfbu
d8b9baf1cb Better font config for Sphinx own PDF docs 2018-03-30 10:32:08 +02:00
jfbu
39ce9d9ab9 Fix Unicode Character U+229E (SQUARED PLUS) breaks Sphinx docs in LaTeX 
refs: PR #4794
 2018-03-30 00:11:17 +02:00
Takeshi KOMIYA
9f5c676322 Use flake8-import-order 2018-01-28 01:52:16 +09:00
Takeshi KOMIYA
f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Stephen Finucane
65a81e2056 doc: Add sphinx-autogen man page 
This wasn't documented in depth anywhere, so do just that.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-07-11 16:08:40 +01:00
Yoshiki Shibukawa
f0766ce4cd fix #3840: epub_uid should be XML Name 2017-06-30 23:37:32 +09:00
jfbu
b18a3f82b4 Fix flake8 2017-05-20 10:16:24 +02:00
jfbu
6422f7b8c9 Fix #3742: missing `Index` bookmark and TOC entry in PDF builds at RTD 
The trick is to create an Index TOC/bookmarks entry in anticipation of
makeindex execution, as RTD (currently) does only one pdflatex run after
makeindex.

    https://github.com/rtfd/readthedocs.org/issues/2857

The workaround works for Sphinx own docs, which uses ``'manual'``
docclass and puts the general index at very end of document.
 2017-05-20 09:54:09 +02:00
Takeshi KOMIYA
bd66ffc1fa Fix the unreleased version number is shown (refs: #3678, #3027) 2017-04-28 01:19:01 +09:00
Takeshi KOMIYA
c57e47e042 Year++ 2017-03-26 11:49:34 +09:00
jfbu
89431bf833 Fix accidental use of `language='ja'` in docs (at 41bb388) 2017-03-23 11:03:38 +01:00
jfbu
41bb38877f Update docs (domains.rst) 2017-03-21 08:24:35 +01:00
jfbu
c240a90f18 improve the index appearance in Sphinx's own PDF documentation 2017-02-05 23:20:30 +01:00
jfbu
a48a9c883a style the latex chapter in the docs (for pdf output) 2016-10-29 16:30:33 +02:00
Takeshi KOMIYA
ec934d476a Fix #2983: Rename `epub3_description and epub3_contributor to epub_description and epub_contributor`. 2016-10-01 00:17:19 +09:00
Yoshiki Shibukawa
8f162a132e fix epub warning in Sphinx's document 2016-08-09 16:58:56 +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
Georg Brandl
46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Georg Brandl
548a6dc22e final pep8 fixes; reactivate most warnings in flake8 2015-03-08 17:15:54 +01:00
shimizukawa
b0d40ea22c Closes #1735: Use https://doc.python.org/ instead of `http protocol. It was used for sphinx.ext.intersphinx` and some documentation. 2015-02-23 04:20:35 +00:00
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Takayuki Shimizukawa
5bd2143fd0 enable sphinx.ext.viewcode for sphinx doc itself 2014-10-28 13:45:27 +09:00
Georg Brandl
a973daea41 make :any: role work with intersphinx! 2014-09-19 13:31:55 +02:00
Georg Brandl
ac92719ac3 Update copyright year. 2014-03-01 08:18:23 +01:00
Georg Brandl
e030031321 Update copyright year. 2014-03-01 08:18:16 +01:00
Rob Ruana
63fbb819c7 Makes suggested changes before adding napoleon to sphinx 2014-01-19 13:43:54 -05:00
Rob Ruana
a00a096069 Merges napoleon extension into mainline sphinx 2014-01-18 13:56:23 -05:00
Roland Meister
73a1420cc6 Add epub_guide entry to doc/conf.py 
The toc for the spinx documentation actually is in contents.rst.
 2013-06-19 21:02:27 +02:00
Takayuki Shimizukawa
649a75c427 add 'locale_dirs' and 'gettext_compact' to conf.py for translation setup easier 2013-03-31 12:22:08 +09:00
Roland Meister
a567d77e51 epub_use_index instead of html_use_index for epub builder (Issue #1106) 
The change adds the method get_builder_config.
This allows use of the option epub_use_index instead
of html_use_index for epub output.
 2013-03-06 18:43:21 +01:00
Roland Meister
32414bf3d3 Add orphan documents as epub_post_files. 2013-02-14 21:34:26 +01:00
shirou
0635eddd07 add "epub_show_urls" option to doc and quickstart. 2013-02-09 23:00:47 +09:00
Georg Brandl
20279b07a4 New doc design "sphinx13". 2013-01-18 23:17:11 +01:00
Georg Brandl
151856819c Copyright update. 2013-01-01 22:13:15 +01:00
Georg Brandl
4763419db1 Update Sphinx URL to new sphinx-doc.org domain. 2012-11-04 11:28:12 +01:00
Roland Meister
024b5950dd Merge with birkenfeld/sphinx 2012-02-13 20:59:37 +01:00
Georg Brandl
ff940a16b6 Add a rudimentary manpage for sphinx-apidoc. 2011-10-07 12:27:19 +02:00
Roland Meister
5cb3823223 Add _static/websupport.js to epub_exclude_files. 2011-02-28 23:20:08 +01:00
Roland Meister
55c7fa44bb Merge with birkenfeld/sphinx. 2011-02-28 23:15:35 +01:00
Roland Meister
246d07807d Added epub_max_image_width configuration option. 2011-02-28 21:17:52 +01:00
Roland Meister
fe07254b9c Added epub_fix_images configuration option 2011-02-27 22:02:30 +01:00
Georg Brandl
5c39cfb6e9 merge with 1.0 2011-01-07 19:04:53 +01:00
Georg Brandl
210add8d2c Parse parmeter field in event descriptions. 2011-01-07 16:27:47 +01:00
Georg Brandl
92a5db16d5 #516: Added new value of the :confval:latex_show_urls option to show the URLs in footnotes. 2011-01-06 18:29:37 +01:00
Georg Brandl
17efae5622 merge with 1.0 2011-01-04 11:29:09 +01:00
Georg Brandl
0e1db6ad90 New year update. 2011-01-04 10:00:51 +01:00
Georg Brandl
db8189083d merge with 1.0 2010-10-22 11:16:48 +02:00
Georg Brandl
39dc69e9d9 Remove obsolete config value. 2010-10-22 07:10:44 +02:00
Jonathan Waltman
a5343b4c5b Add documentation for Texinfo builder 2010-09-16 02:16:27 -05: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
01c501054e #480: Fix handling of target naming in intersphinx. 2010-08-05 11:58:43 +02:00
Roland Meister
13adb67063 Correct handling of extensions for extra files 2010-06-07 22:28:48 +02:00
Roland Meister
ef63485c6e Added one more epub_exclude_file. 2010-06-03 15:39:24 +02:00
Georg Brandl
c671e81d6c Restore sphinxdoc theme. 2010-05-25 23:59:22 +02:00
Georg Brandl
784e598743 In the default theme, the sidebar can experimentally now be made collapsible using the new `collapsiblesidebar` theme option. 2010-05-24 23:14:35 +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
f4f3066581 Use the new rst domain in the sphinx docs. 2010-04-17 10:39:51 +02:00
Georg Brandl
4f2523d17f Mention standard rst roles in inline markup. 2010-03-01 15:01:46 +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
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
04f660d021 Change domain-index API: introduce a class. 2010-02-28 14:45:43 +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
121b864f31 Add manual page writer. 2010-02-21 11:50:08 +01:00
Georg Brandl
baf0087f3a merge with trunk 2010-01-17 18:29:16 +01:00
Georg Brandl
31c5290fb8 Clean up conf.py file for the docs. 2010-01-17 18:16:14 +01:00
Georg Brandl
c98236bc61 Finish new doc field handling implementation. 2010-01-17 12:05:44 +01:00
Georg Brandl
edb89b1940 Add the "viewcode" extension. 2010-01-13 23:53:01 +01:00
Georg Brandl
b1c937f0d9 merge with trunk (not working perfectly yet) 2010-01-07 21:41:03 +01:00
Georg Brandl
2f09d24472 The `html_sidebars` config value can now contain patterns as keys, and the values can be lists that explicitly select which sidebar templates should be rendered. 
That means that the builtin sidebar contents can be included only selectively.
 2010-01-07 17:56:09 +01:00
Georg Brandl
ab7ac64e1a Add new universal config value `exclude_patterns`, with glob-style exclude patterns. 
This makes the old ``unused_docs``, ``exclude_trees`` and ``exclude_dirnames`` obsolete.
 2010-01-06 15:48:39 +01:00
Georg Brandl
faeec5cbbb merge with trunk 2010-01-02 21:03:56 +01:00
Georg Brandl
6b13a28c11 Make extlinks more flexible: use string substitution to build the full URL. 2010-01-02 20:51:22 +01:00
Georg Brandl
47ccbccc62 merge with 0.6 2010-01-01 14:10:48 +01:00
Georg Brandl
f6a56192d1 Happy new year! 2010-01-01 14:09:13 +01:00
Georg Brandl
f3a2854ba9 merge with trunk 2009-12-31 18:40:58 +01:00
Georg Brandl
24fb46226f Review of epub builder. Add a separate "epub_theme" config value for selecting a different theme. 2009-12-29 12:32:42 +01:00
Roland Meister
eee47685fa Activated html_theme 'epub' 2009-12-28 17:11:15 +01:00
Roland Meister
706e12da65 Initial import from local repository 2009-12-28 17:09:09 +01:00
Georg Brandl
a51e3a4129 Add missing extension. 2009-10-08 09:14:01 +02:00
Georg Brandl
b4ef4bd670 app: allow giving the localized object name when adding new object types. 2009-09-08 00:04:05 +02:00
Georg Brandl
ebcf18d9c3 Added the `latex_docclass` config value and made the "twoside" 
documentclass option overridable by "oneside".
 2009-06-04 17:50:37 +02:00
Georg Brandl
e46e989d8b No need to use extlinks in conf.py. 2009-05-02 20:48:30 +02:00
Georg Brandl
58da7a84fd Added the `extlinks` extension. 2009-05-02 20:38:45 +02:00
Pauli Virtanen
d9ae7c30cb autosummary: write documentation 2009-04-04 22:05:04 +03:00
Georg Brandl
d3a7f004f0 Oops. 2009-02-20 11:09:54 +01:00
Georg Brandl
d4f5796f3b The HTML builder now stores a small file named `.buildinfo` in 
its output directory.  It stores a hash of config values that
can be used to determine if a full rebuild needs to be done (e.g.
after changing ``html_theme``).
 2009-02-19 16:15:36 +01:00
Georg Brandl
11a7ed8c49 merge with mq 2009-01-10 22:19:40 +01:00
Georg Brandl
aedbdd953d Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +01:00
mq
ab4c11f641 add modindex_common_prefix config value 2009-01-10 21:54:26 +01:00
Georg Brandl
4d345c8de3 Split stylesheets into basic, default and sphinxdoc. 2009-01-10 20:45:45 +01:00
Georg Brandl
ec392f4888 Add Pygments style selection to theming. 2009-01-10 19:14:01 +01:00
Georg Brandl
beb987bd5b Basic theme infrastructure. 2009-01-05 20:22:30 +01:00
Georg Brandl
5df8e162f9 Fix a few remaining copyrights and add 2009 to license. 2009-01-04 14:39:36 +01:00
Georg Brandl
4f8a18d841 Use an explicit language. 2008-11-19 18:31:11 +01:00
Georg Brandl
0060e50efa Add todo extension. 2008-11-09 19:46:32 +01:00
Georg Brandl
00de8e0d36 Use palatino for the Sphinx docs. 2008-09-24 16:18:45 +00:00
Georg Brandl
87a05a41cb Merged revisions 66061,66069 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r66061 | georg.brandl | 2008-08-30 11:43:20 +0200 (Sat, 30 Aug 2008) | 2 lines

  Show last released version in built docs.
........
  r66069 | georg.brandl | 2008-08-30 15:21:40 +0200 (Sat, 30 Aug 2008) | 2 lines

  XeTeX fix by Markus Gritsch.
........
 2008-08-30 21:56:43 +00:00
Georg Brandl
c21ff79a8b English is nice for the official docs nevertheless. 2008-08-08 11:00:29 +00:00
Georg Brandl
a7cfb52ab6 Add i18n support, thanks to Horst Gutmann. 2008-08-08 10:54:00 +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
5941814c4a Add math support to Sphinx. 2008-08-06 13:04:14 +00:00
Georg Brandl
c1bedfc105 Add general docstring processing support with a new event in autodoc. 2008-06-22 21:02:50 +00:00
Georg Brandl
242e343c10 Follow renaming of desc_classname to desc_addname. 2008-06-18 18:33:11 +00:00
Georg Brandl
2b0e015fcc Add html-page-context event for customizing the template context. 2008-05-31 16:14:36 +00:00
Georg Brandl
9fc2a9b7ad Add `toctree_only` feature to LaTeX builder. 2008-05-04 21:35:03 +00:00
Georg Brandl
eeb8a4b27e Use correct OpenSearch base url. 2008-05-03 20:18:53 +00:00
Georg Brandl
5caa6d01c5 * New LaTeX table handling. 
* Support parts in LaTeX output.
 2008-05-03 18:14:13 +00:00
Georg Brandl
0ee5e39253 Fetch Sphinx version from Sphinx itself. 2008-04-27 20:12:41 +00:00
Georg Brandl
262edb1413 Add logo options, add blocks to sidebar. 2008-04-27 19:43:45 +00:00
Georg Brandl
0fba8f435e Use OpenSearch for Sphinx docs. 2008-04-27 18:09:49 +00:00
Georg Brandl
ec04b2f4ff * Use a customizable title for the docs. 
* Fix up the clumsy index template handling.
 2008-04-19 21:28:24 +00:00
Georg Brandl
ea2f87fc03 Allow the config to act as an extension. 2008-04-06 17:38:55 +00:00
Georg Brandl
5f78bc436b Use Windows-friendlier dirnames. 2008-03-21 15:20:50 +00:00
Georg Brandl
77441d7549 * Add docs for sphinx.ext.doctest. 
* Update parse_node functions.
 2008-03-21 14:06:04 +00:00
Georg Brandl
ae7273b9ae * Define __file__ during conf.py execution. 
* Make staticpath relative to conf.py dir.
 2008-03-16 20:52:34 +00:00
Georg Brandl
f2d713c577 Add documentation for autodoc. 2008-03-14 23:35:08 +00:00
Georg Brandl
ccfd92e558 First pass at Sphinx documentation. Most of it still needs to be written :) 2008-03-09 21:32:24 +00:00