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
13,349 Commits 2 Branches 219 Tags 163 MiB
2f97b86bfd
Commit Graph

178 Commits

Author SHA1 Message Date
Stephen Finucane
96cf498c9e apidoc: Move apidoc to ext/apidoc 
The 'sphinx-apidoc' tool is no longer the only kid on the block when it
comes to automatic documentation of Python projects, with the likes of
'sphinx-autoapi' in development [1], and is not really maintained. Given
the fact that the tool is tangential to Sphinx's main goal, there isn't
really anything that warrants its continue existence as a core module.

Signify this by moving the feature to 'ext'. This allows the feature to
continue to exist in the package, but indicates that stability might be
worse than one would expect from the core library.

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

[1] https://github.com/rtfd/sphinx-autoapi
[2] https://github.com/sphinx-doc/sphinx/pull/3485#issuecomment-288081223
[3] https://github.com/django/django/blob/1.11/django/test/runner.py#L688-L695

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-09-20 13:42:57 +01:00
Takeshi KOMIYA
2d9034d3af Fix flake8 violations 2017-05-26 00:42:28 +09:00
Takeshi KOMIYA
ca6a1edd2f Merge branch 'stable' 2017-05-26 00:15:00 +09:00
Takeshi KOMIYA
180d665b6c setup.py: Add requires for installation from tarball 2017-05-26 00:13:47 +09:00
Takeshi KOMIYA
13a383e061 Refactor setup.py 2017-05-26 00:12:45 +09:00
Julien Schueller
ee286e4f27 Do not require typing module for python>=3.5 
pkg_resources.DistributionNotFound: The 'typing' distribution was not found and is required by Sphinx
 2017-05-26 00:11:06 +09:00
Julien Schueller
3ea4ed9cad Do not require typing module for python>=3.5 
pkg_resources.DistributionNotFound: The 'typing' distribution was not found and is required by Sphinx
 2017-05-25 09:48:22 +02:00
Takeshi KOMIYA
0135948485 Fix #3683: sphinx.websupport module is not provided by default 2017-05-03 23:00:03 +09:00
Takeshi KOMIYA
370bdddc7c make websupport-dependency optional 2017-04-29 15:29:51 +09:00
Takeshi KOMIYA
fef9f870d4 Split websupport to sphinxcontrib-websupport package 2017-04-22 17:54:20 +09:00
Brecht Machiels
ce5799a37a Builder entry points require pkg_resources/setuptools 2017-04-10 13:08:33 +02:00
Alexander Shadchin
992a795907 Fix test depend 2017-02-26 15:31:21 +03:00
Takeshi KOMIYA
d33cf04979 Merge branch 'stable' 2017-01-29 18:05:17 +09:00
Takeshi KOMIYA
14a864a637 Support requests-2.0.0 (experimental) (refs: #3367) 2017-01-29 13:15:49 +09:00
Takeshi KOMIYA
5c72b8cf47 Merge branch 'stable' 2017-01-07 15:36:55 +09:00
Takeshi KOMIYA
70cdc7be8f Dependency requirement updates: requests 2.4.0 or above (refs: #3268, #3310) 2017-01-07 14:29:36 +09:00
shimizukawa
0a7d039df5 Merge branch '1.5-release' into master 2016-12-05 23:14:25 +09:00
shimizukawa
37a41be2a2 small fix in setup.py and release-checklist. 2016-12-04 22:03:25 +09:00
Takeshi KOMIYA
db732ac0b8 Prepare to type-check using mypy 2016-11-16 12:05:44 +09:00
Takeshi KOMIYA
3c3c8e7533 Fix flake8 violation 2016-11-16 12:02:40 +09:00
Takeshi KOMIYA
c147f6496e Fix #2919: Drop py26 support 2016-09-15 22:47:47 +09:00
Takeshi KOMIYA
1da1a71511 Drop python 3.3 support 2016-08-30 00:43:15 +09:00
Takeshi KOMIYA
184bedef4b Merge branch 'stable' 2016-08-20 18:06:33 +09:00
Takeshi KOMIYA
dbac9aa8ec Add compile_grammar command to setup.py (ref: #2765) 2016-08-19 20:16:02 +09:00
Julien Schueller
626be8b5f3 Require six 1.5 for html_parser 2016-08-18 09:34:43 +02:00
Takeshi KOMIYA
2ccb75c98f Bundle sphinx/pycode/Grammar-*.pickle (ref: #2765) 
So far, sphinx generates the grammar files on demand.
It causes uninstallation does not remove whole of files.
With this fix, Sphinx bundles the files in the package.
 2016-07-12 12:15:12 +09:00
Ville Skyttä
e8a8be5788 Handle more file closing with "with" 2016-07-07 18:53:34 +03:00
Avram Lubkin
76b92ad24f Use html5lib to parse HTML in tests instead of XMLParser 2016-05-28 02:51:21 -04:00
Takeshi KOMIYA
2578f47664 Merge branch 'stable' 2016-05-26 20:55:26 +09:00
Dmitry Shachnev
65638c12b8 Make our custom compile_catalog command work with Babel 2.3 
In new Babel versions, self.domain is a list rather than a string.
 2016-05-17 15:43:59 +03:00
Darragh Bailey
0b9ee8d451 Switch to using requests for better charset detection 
Python requests does a better job of detecting the charsets of
webpages, performing automatic decoding when the text content is
requested, avoiding issues around needing to do detection.

This allows checking the following urls & anchors correctly:

    http://www.yaml.org/spec/1.2/spec.html#id2761803
    http://www.yaml.org/spec/1.2/spec.html#id2765878
    http://www.yaml.org/spec/1.2/spec.html#id2765878
 2016-04-21 13:20:02 +01:00
Alex Gaynor
7b759b1db7 Removed ez_setup.py 
There are no common cases where it will be used anymore:

* pip always installs stuff with setuptools
* Modern pythons preinstall setuptools
 2016-02-13 10:14:16 -05:00
Takeshi KOMIYA
fd674ef9f9 Fix #2199: Use `imagesize` package to obtain size of images 2016-02-10 00:46:22 +09:00
Takayuki SHIMIZUKAWA
4391521b81 Merge pull request #2087 from cppformat/optional-rtd 
refs #2087, #2086, #1845, #2097: Make sphinx_rtd_theme optional
 2016-01-15 11:55:09 +09:00
Takeshi KOMIYA
e4b9eb51f6 Merge branch 'stable' 2016-01-11 00:27:26 +09:00
shimizukawa
dc0873adf6 Fix #1820: On Windows, console coloring is broken with colorama version 0.3.3. Now sphinx use colorama>=0.3.5 to avoid this problem. 2016-01-06 07:27:34 +09:00
vitaut
12dde8afdb Make sphinx_rtd_theme optional 2015-10-16 06:58:12 -07:00
Takayuki SHIMIZUKAWA
a7723ff6f4 Merge pull request #2009 from ProgVal/determinism 
Make files generation at install deterministic
 2015-09-13 12:39:28 +09:00
Anthony Johnson
8cf1612e37 Tune sphinx_rtd_theme version 
With some recent changes that are slightly backwards compatible, we were going
to bump the version of the RTD theme. We wanted to drop the current version
pattern for the semver scheme, but Sphinx's requirement on the RTD theme is
pinned at >=0.1,<0.2. For now, we're stuck releasing on the current scheme.

This relaxes the versioning requirement for the theme, with 2.0 being the
following release that could contain backwards incompatible API changes. We'd
likely wait to bump to 1.0 until the next Sphinx release, as to not break
experience for users.

Refs snide/sphinx_rtd_theme#244
 2015-09-13 10:08:00 +09:00
Takayuki SHIMIZUKAWA
bf795b9000 Merge pull request #2031 from agjohnson/rtd-theme-version 
Tune sphinx_rtd_theme version
 2015-09-13 10:00:16 +09:00
shimizukawa
6bce0a1c10 Avoid "2.0" version of Babel because it doesn't work with Windows environment. Closes #1976. 
see also:
* https://github.com/mitsuhiko/babel/issues/174
* https://github.com/mitsuhiko/babel/pull/188

Version spec syntax "babel>=1.3,!=2.0" is following PEP440: https://www.python.org/dev/peps/pep-0440/#version-exclusion and it works with pip 6.0 or later (I didn't check before pip 6.0).
 2015-09-13 09:40:14 +09:00
Anthony Johnson
e6ddd326d1 Tune sphinx_rtd_theme version 
With some recent changes that are slightly backwards compatible, we were going
to bump the version of the RTD theme. We wanted to drop the current version
pattern for the semver scheme, but Sphinx's requirement on the RTD theme is
pinned at >=0.1,<0.2. For now, we're stuck releasing on the current scheme.

This relaxes the versioning requirement for the theme, with 2.0 being the
following release that could contain backwards incompatible API changes. We'd
likely wait to bump to 1.0 until the next Sphinx release, as to not break
experience for users.

Refs snide/sphinx_rtd_theme#244
 2015-09-09 11:38:03 -07:00
Valentin Lorentz
a9323e6f59 Make Javascript locale deterministic. 2015-08-19 20:38:23 +02:00
Takayuki SHIMIZUKAWA
b557b5665c Merge pull request #1759 from bitprophet/patch-1 
Version-lock unlocked dependencies
 2015-03-09 10:52:17 +09:00
Georg Brandl
548a6dc22e final pep8 fixes; reactivate most warnings in flake8 2015-03-08 17:15:54 +01:00
Jeff Forcier
2f76149acf Version-lock unlocked dependencies 
As the author of one of the new theme dependencies (`alabaster`), having a wholly unqualified requirement scared me a bit re: ability to make non-bugfix releases without downstream users' sites changing underneath them in unexpected (visual) ways without them consciously upgrading Sphinx versions.

`alabaster` uses semantic versioning so the lock reflects this.

For consistency, I also updated the other new theme dependency similarly, and made `babel` match its fellow non-theme dependencies in having an optimistic (vs semantic) version lock, but I can revert these changes if desired.
 2015-03-07 07:35:04 -08:00
shimizukawa
bc6df36d37 add extras_require for websupport and test. 2015-03-07 16:53:32 +09:00
shimizukawa
cdc4f5d8bb fix http/https 2015-02-28 01:10:03 +09:00
shimizukawa
68021b0bd3 refs #1346. Add new default theme. 
- Rename 'default' theme to 'classic'.
  - rename `themes/default` to `themes/classic`
  - add new `themes/default` theme that derives from 'classic' theme for compatibility.
- setup.py depends to 'alabaster' and 'rtd' theme.
- theming.py import and run `alabaster.get_path()` to append path for alabaster theme.
- theming.py also import and run `sphinx_rtd_theme.get_html_theme_path()` to append path.
- sphinx-quickstart will generate `html_theme = 'alabaster'`.
- If user use 'default', sphinx emit notice (WARNING) suggestion to use 'alabaster' or use 'classic'.
- add documentation for new alabaster and readthedoc theme and link to original pages:
  - https://pypi.python.org/pypi/alabaster
  - https://pypi.python.org/pypi/sphinx_rtd_theme
 2015-02-24 01:01:54 +09:00
shimizukawa
a9c1ab9828 Merge branch 'stable' 
Conflicts:
	setup.py
 2015-01-06 22:26:56 +09:00
shimizukawa
ddb7c9945d Exclude 'tests' instead of 'test'. Sphinx-1.2.3 wheel package includes 'tests' directory. It might be happen by this wrong parameter. 2015-01-06 22:23:05 +09:00
Georg Brandl
fadfa5ecf7 Require newer docutils and Pygments. 2015-01-01 19:02:19 +01:00
Takayuki Shimizukawa
8d514be7a8 Provides environment marker (PEP-0426) to install colorama on win32 environment for installation from wheel. 2014-12-13 18:34:55 +09:00
Takayuki Shimizukawa
4ee821efa3 add PyPI classifiers for sphinx 2014-11-27 09:58:53 +09:00
Takayuki Shimizukawa
7207b614b6 merge with stable 2014-09-02 00:11:32 +09:00
Takayuki Shimizukawa
b7629471e5 run make check and correct errors. 2014-09-01 23:16:54 +09:00
Takayuki Shimizukawa
eaed3ca9f1 Automatically compile `*.mo files from *.po` files. 2014-08-03 16:22:08 +09:00
anatoly techtonik
61ec2c6d23 raise six requirement to 1.4+ when UserString was added 2014-07-28 09:04:32 +00:00
Takayuki Shimizukawa
6ab7a2cbec Windows color console support. update for pull request #252. 2014-07-05 01:16:33 +09: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
15879896fd remove custom_fixers. it is not needed anymore. 2014-05-03 13:26:36 +09:00
Takayuki Shimizukawa
956d6286bf remove 2to3. #1350. 2014-05-01 17:27:27 +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
18755458a1 merge with stable 2014-03-25 09:31:44 +01:00
Takayuki Shimizukawa
b751d5db52 Fix: Generated i18n sphinx.js files are missing message catalog entries from '.js_t' and '.html'. The issue was introduced from Sphinx-1.1. Closes #1419 2014-03-21 10:58:41 +09:00
Georg Brandl
afd6c0b28d Merged in shibu/sphinx/add_stemmer (pull request #214) 2014-03-04 19:10:19 +01:00
Georg Brandl
c3836b3188 Merged in shimizukawa/sphinx-drop-old-docutils (pull request #206) 
Drop docutils-0.7, 0.8, 0.9 support.
 2014-03-01 08:20:21 +01:00
Georg Brandl
1eb23c62ce merge with stable 2014-01-22 18:13:49 +01:00
Georg Brandl
216c664187 remove mention of development egg. 2014-01-22 18:04:44 +01:00
shibukawa yoshiki
ca63dba2ad merge default 2014-01-22 00:10:09 -08:00
shibukawa yoshiki
a01e56fde9 add 14 languages search support 2014-01-20 02:09:21 -08:00
Takayuki Shimizukawa
2050285ebf Drop docutils-0.7, 0.8 and 0.9 support 2013-12-15 16:25:01 +09:00
Takayuki Shimizukawa
f7cb510ebd Drop python-3.1 and remove support codes 2013-12-15 16:04:23 +09:00
Takayuki Shimizukawa
a8fc938d1b Drop python-2.5 and remove 2.4,2.5 support codes 2013-12-15 14:16:53 +09:00
Takayuki Shimizukawa
e81a2d884e Added a ez_setup to replace distribute_setup. ez_setup become defacto. Closes #1264 2013-10-03 05:55:58 +00:00
Takayuki Shimizukawa
b2997a652e Fix Python version compatibility with Jinja2 2.7. closes #1173 2013-05-29 09:16:14 +00:00
Jonathan Waltman
4e715ff0bf Avoid unknown option warnings for use_2to3 in setup.py under Python 2. 2012-11-11 01:33:52 -06:00
Georg Brandl
4763419db1 Update Sphinx URL to new sphinx-doc.org domain. 2012-11-04 11:28:12 +01:00
Jonathan Waltman
025ae13703 setup.py: Update "requires" to docutils>=0.10.0 under Python 3.3 2012-11-03 12:29:55 -05:00
Jonathan Waltman
0e44cb20a1 setup.py: Require Docutils >= 0.10 when running under Python >= 3.3 2012-11-03 11:11:38 -05:00
Georg Brandl
2671d55436 Update required Python to 2.5. 2012-10-30 09:55:44 +01:00
Georg Brandl
de117ea974 Pre-release updates. 2011-10-09 23:25:40 +02:00
Georg Brandl
608edd427c Fix #758: do not install custom_fixers and tests "packages". 2011-10-05 15:31:50 +02:00
Georg Brandl
142c15093a Upgrade the version requirements. 2011-09-25 08:31:27 +02:00
Georg Brandl
87cebf1a07 #98: Add autopackage script. (Undocumented for now.) 2011-01-04 19:20:22 +01:00
Georg Brandl
867b421178 Invert setup.py uuid logic. 2010-08-21 22:14:57 +02:00
Daniel Neuhäuser
c3905938ea Use uuid as a requirement in the setup.py and mention it in the documentation for Python 2.4 2010-08-15 20:48:19 +02:00
Daniel Neuhäuser
e20b61b06e Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
Daniel Neuhäuser
4f13ff1ab7 Added a distribute_setup to replace ez_setup 2010-05-08 22:33:36 +02:00
Daniel Neuhäuser
89cb0714b1 Removed ez_setup which doesn't work with python3 and added use_2to3 for distribute 2010-05-08 20:34:19 +02:00
Georg Brandl
94b14dc39b Update for 1.0. 2010-07-23 12:42:03 +01:00
Georg Brandl
7f818affe4 Require docutils 0.5, as announced. 2010-05-26 00:22:28 +02:00
Georg Brandl
4dfe623d7d Update trove classifiers. 2010-05-25 01:08:52 +02:00
Georg Brandl
c8c703805c merge with 0.6 2010-05-22 12:59:18 +02:00
Georg Brandl
2477249d42 #417: Don't force dependency on the setuptools version mandated by ez_setup.py. 2010-05-22 10:32:33 +02:00
Georg Brandl
0ee675b7cf Update blurb in setup.py and on the index page, link directly to tutorial.rst from index. 2010-02-28 23:12:00 +01:00
Georg Brandl
a515165be6 Update Jinja2 requirement. 2010-02-17 10:38:59 +01:00
Georg Brandl
59a7070e7e Update long_description a bit. 2010-01-12 21:01:49 +00:00
Georg Brandl
2f8debc501 Oops. 2009-10-22 18:07:31 +02:00
Georg Brandl
ff6ed15edf test 2009-09-17 19:29:01 +02:00