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,827 Commits 2 Branches 219 Tags 163 MiB
0782273dec
Commit Graph

124 Commits

Author SHA1 Message Date
Takeshi KOMIYA
dc4f8d4836 conf.py: Drop epub_author, epub_publisher and epub_copyright 
The default values of them are same as conf.py's. So it is not
needed to override the setting.
 2018-08-05 08:16:00 +09:00
Takeshi KOMIYA
f7027049b1 Fix flake8 violations 2018-02-19 23:20:56 +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
Takeshi KOMIYA
a9efb2517a Fix flake8 violations 2017-12-23 21:21:21 +09:00
Stephen Finucane
d46273ca4a quickstart: Rework how we collect extensions 
This is a little more flexible than the existing set up and makes
maximum use of argparse capabilities.

This has the side-effect of no longer including configuration for the
'sphinx.ext.todo' extension when said extension is not enabled.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-12-03 19:24:58 +00:00
Stephen Finucane
4c0f657ee6 quickstart: Rework 'do_prompt' function 
The 'd' and 'key' values are used on a single line. Move these outside
the function to allow us to do other things with this function.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-12-03 19:24:58 +00:00
Stephen Finucane
1f5ed02225 sphinx-quickstart: Move code to 'sphinx.cmd' 
We're going to move the executable's here (or at least those that part
of the core library). The 'sphinx-build' executable was already moved,
so lets do 'sphinx-quickstart' next.

To avoid breaking packages that are using this feature directly, aliases
for the old 'main' method are included. This is based on what Django
does [1] and, like Django, will allow us to safely remove the old
modules in Sphinx 2.0.

[1] https://github.com/django/django/blob/1.11/django/test/runner.py#L688-L695

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-10-02 15:42:23 +01:00
shimizukawa
d497d74370 refs #3458: add sphinx.testing that are moved from /tests directory. 2017-05-14 20:47:15 +09:00
Takeshi KOMIYA
7cca0b456e Merge pull request #3668 from adamjstewart/fixes/apidoc-main-argv 
Don't ignore first argument passed to sphinx.apidoc.main
 2017-05-14 01:11:49 +09:00
Adam J. Stewart
326ddd10d7 Fix failing unit tests 2017-05-11 12:53:15 -05:00
Takeshi KOMIYA
8fda21099d Remove deprecated testing utilities 2017-04-27 23:38:42 +09:00
Takeshi KOMIYA
c57e47e042 Year++ 2017-03-26 11:49:34 +09:00
shimizukawa
f962ad67d2 pytest: remove deprecated raises and raises_msg assert functions 2017-01-06 00:46:42 +09:00
shimizukawa
d0a33dd785 pytest: remove deprecated with_tempdir decorator 2017-01-06 00:26:01 +09:00
Takeshi KOMIYA
ae1f523d52 Add `--extensions to sphinx-quickstart` to support enable arbitary extensions from command line (ref: #2904) 2016-11-02 11:11:15 +09:00
Georg Brandl
4f72bdb722 Merge branch 'stable' 2016-01-14 22:54:08 +01:00
Georg Brandl
46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Takeshi KOMIYA
0ea518d563 Add sphinx.ext.githubpages to publish the docs on GitHub Pages 2016-01-06 22:14:57 +09:00
Hong Xu
ea25284d0a Replace pngmath with imgmath in quickstart. 2015-12-29 15:14:04 -08:00
shimizukawa
a94c40cbcf ref #1776: test fixed. 2015-03-16 00:27:12 +09:00
Georg Brandl
bf3bdcc7f5 source_suffix can now be a list. 2015-02-08 20:13:47 +01:00
Ian Lee
9302231342 Added insertion of todo_include_todos config option. 
Set to True when we enable 'ext_todo' during the quickstart process.
 2015-02-07 00:00:08 -08: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
Georg Brandl
d47a7587f9 Complete test suite overhaul. 
* rename a few test modules to make the names more consistent

* do not copy/use Sphinx from build/ (unnecessary without 2to3)

* use a temporary dir for *all* test projects, the source tree
  will stay pristine that way  (default is tests/build)

* speed up tests by ~3x by splitting up test projects and avoiding
  rebuilds
 2014-09-21 17:17:02 +02:00
Takayuki Shimizukawa
6746c83a18 * Drop Python-3.2. And now, removing 2to3 mechanism procedure has been completed. Closes #1350. 
Pygments-2.0 will drop Python-3.2.
The snowballstemmer package that is referred from sphinx-1.3 (that is merged at pull request #214) has not supported Python-3.2.

We decided to drop the Python-3.2.

see also https://bitbucket.org/birkenfeld/sphinx/pull-request/243/native-py2-py3-support-without-2to3-refs
 2014-05-27 23:17:36 +09:00
Takayuki Shimizukawa
1e58062692 remove 'six' name except importing line. 2014-04-30 21:30:46 +09:00
Takayuki Shimizukawa
00eff0b7f6 use six privided text_type() to replace with unicode() to support py2/py3 in one source. refs #1350. 2014-04-29 23:44:12 +09:00
Takayuki Shimizukawa
c3c879f2c6 use six privided functions/classes to support py2/py3 in one source. refs #1350. 2014-04-29 19:59:58 +09:00
Takayuki Shimizukawa
68290a266c introduce the six module and reduce sphinx.util.pycompat implementation. refs #1350. 2014-04-29 11:46:47 +09: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
Georg Brandl
336ae30edb Prompt for the document language in sphinx-quickstart. 2014-01-11 15:05:45 +01:00
Takayuki Shimizukawa
be65b99879 grammar fix: 'multibyte filename' is ambiguous. They are replaced with 'non-ASCII filename'. refs #703 2013-10-03 06:43:22 +00:00
Georg Brandl
895899b7bb small grammar fix in multibyte filename messages 2013-10-01 19:50:32 +02:00
Takayuki Shimizukawa
58be2f19b3 When Sphinx couldn't decode multibyte filename, now Sphinx notices UnicodeError and continuing if possible instead of raise exception. Closes #703 2013-09-28 12:51:20 +00:00
Takayuki Shimizukawa
dbe60b4e02 refactoring: 'tmpdir' rename to 'tempdir' that is same name in other places. 2013-06-13 03:24:20 +00:00
Takayuki Shimizukawa
8c543c11cc Fix: Output TeX/texinfo/man filename has no basename (only extention) when using multibyte characters to "Project name" on quickstart. Closes #1190 2013-06-13 03:22:23 +00:00
Takayuki Shimizukawa
f24eb8c47d fix typo ;) 2013-06-13 03:08:57 +00:00
Takayuki Shimizukawa
f2de6cdb6d fix for unicode object syntax. ur'' is meaningless. 2013-06-13 02:51:17 +00:00
Takayuki Shimizukawa
8ec83f963b Fix "Title underline is short" WARNING is given when using fullwidth characters to "Project name" on quickstart. Closes #1189 2013-06-09 09:48:43 +09:00
Takayuki Shimizukawa
573d8433b9 Fix sphinx-quickstart raises UnicodeEncodeError if "Project version" includes non-ASCII characters. Closes #1188 2013-06-09 09:06:21 +09:00
Georg Brandl
1af3e3ea71 tests: replace "from util import *" by explicit imports 2013-04-01 11:39:32 +02:00
Takayuki Shimizukawa
a462284f95 fix: make.bat is always saved with 'LF' instead of 'CRLF' for both Win/Unix. 2013-02-10 11:51:36 +09:00
Takayuki Shimizukawa
05718e4a1a conf.py now accept CRLF end-of-line. 2013-02-10 15:25:45 +09:00
Georg Brandl
151856819c Copyright update. 2013-01-01 22:13:15 +01:00
Takayuki Shimizukawa
e9c0582713 fix: sphinx-quickstart asks again and again Y|N because input() return value with extra '\r' on Python-3.2.0 + Windows. closes #1043 2012-11-28 23:21:02 +09:00
Georg Brandl
75ec8f27d5 Fixes #875 and #876: use the right file mode to successfully read config files under 2.x and 3.x. 2012-03-10 18:45:14 +01:00
Georg Brandl
ba95709f87 Remove unused import. 2011-10-07 11:55:37 +02:00
Georg Brandl
827cdb6266 Split user queries and file generation in quickstart into two functions. 2011-10-07 11:52:12 +02: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
Jonathan Waltman
1a5f00d83c Remove left-over debugging code 2010-09-16 02:34:54 -05:00
Jonathan Waltman
13684aa91f Add tests for Texinfo builder 2010-09-16 02:19:06 -05:00
Georg Brandl
67ffb9bf54 Fix raw_input which is not converted by 2to3 if not called. 2010-07-28 20:24:35 +02:00
Daniel Neuhäuser
625127fd63 Fix SyntaxError in config generated by quickstart and the quickstart test 2010-05-28 04:08:15 +02:00
Georg Brandl
420adbce2f Make it easier for the test suite to override raw_input for test_quickstart. 2010-07-28 18:19:17 +02:00
Daniel Neuhäuser
25b16f89e0 Use code objects for exec statements instead of files 2010-05-08 22:00:15 +02:00
Daniel Neuhäuser
4391e63b07 Move open() calls out of the try block 2010-05-01 20:26:05 +02:00
Daniel Neuhäuser
21376f21e7 Don't use execfile() anymore 2010-04-29 20:34:08 +02:00
Georg Brandl
121b864f31 Add manual page writer. 2010-02-21 11:50:08 +01:00
Georg Brandl
344dab342f Add viewcode to quickstart. 2010-01-17 17:02:46 +01:00
Georg Brandl
f6a56192d1 Happy new year! 2010-01-01 14:09:13 +01:00
Georg Brandl
ba0039cc4d Bring some more sanity into quickstart validators. 2009-04-29 12:26:38 +02:00
Georg Brandl
8f44464e3b Fix the fix of #127 to actually work. 2009-03-24 11:15:24 +00:00
Georg Brandl
98311e1779 Forgot ifconfig. 2009-02-20 10:45:24 +01:00
Georg Brandl
5b1415d16a Fix #103: add all (usable) builtin extensions to quickstart. 2009-02-20 10:43:56 +01:00
Georg Brandl
a759690221 merge in Murkt's branch 2009-01-04 22:33:00 +01:00
Georg Brandl
0b28b3e6f6 Switch copyright and license tags to single style. Add contributor 
names in AUTHORS instead, and add the license of etree13 to
LICENSE.
 2009-01-03 11:57:07 +01:00
Georg Brandl
688ef9dc1f Properly escape authors and titles put into quickstart latex_documents setting. 2008-10-16 19:43:15 +00:00
Georg Brandl
00b30f6f65 Add a test suite for autodoc. 2008-08-04 19:39:05 +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
ae2570c269 Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64808 | georg.brandl | 2008-07-08 21:39:33 +0200 (Tue, 08 Jul 2008) | 2 lines

  Allow relocation of source and doctree dir.
........
  r65013 | georg.brandl | 2008-07-16 15:25:30 +0200 (Wed, 16 Jul 2008) | 2 lines

  Remove curious quote.
........
  r65076 | georg.brandl | 2008-07-17 22:43:01 +0200 (Thu, 17 Jul 2008) | 2 lines

  Add a test for sphinx.quickstart.
........
  r65100 | georg.brandl | 2008-07-18 14:41:54 +0200 (Fri, 18 Jul 2008) | 2 lines

  Fix phony targets.
........
  r65101 | georg.brandl | 2008-07-18 14:55:03 +0200 (Fri, 18 Jul 2008) | 2 lines

  Fix problems in "make check".
........
  r65119 | georg.brandl | 2008-07-18 23:06:42 +0200 (Fri, 18 Jul 2008) | 2 lines

  Emit a more precise error message in autodoc.
........
  r65121 | georg.brandl | 2008-07-18 23:41:35 +0200 (Fri, 18 Jul 2008) | 2 lines

  Warn if a toctree-included document doesn't contain a title.
........
  r65122 | georg.brandl | 2008-07-18 23:51:28 +0200 (Fri, 18 Jul 2008) | 2 lines

  Don't use \samp{} for code with whitespaces, only for :samp:`code`.
........
  r65123 | georg.brandl | 2008-07-19 00:49:46 +0200 (Sat, 19 Jul 2008) | 2 lines

  Put inheritance info always on its own line.
........
 2008-07-18 22:55:36 +00:00