Hello community,
here is the log from the commit of package python-pylons-sphinx-themes for
openSUSE:Leap:15.2 checked in at 2020-03-02 13:21:03
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Leap:15.2/python-pylons-sphinx-themes (Old)
and /work/SRC/openSUSE:Leap:15.2/.python-pylons-sphinx-themes.new.26092
(New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-pylons-sphinx-themes"
Mon Mar 2 13:21:03 2020 rev:15 rq:776985 version:1.0.11
Changes:
--------
---
/work/SRC/openSUSE:Leap:15.2/python-pylons-sphinx-themes/python-pylons-sphinx-themes.changes
2020-01-15 15:52:00.739548689 +0100
+++
/work/SRC/openSUSE:Leap:15.2/.python-pylons-sphinx-themes.new.26092/python-pylons-sphinx-themes.changes
2020-03-02 13:21:04.194125504 +0100
@@ -1,0 +2,36 @@
+Sat Jan 18 18:44:20 UTC 2020 - Arun Persaud <[email protected]>
+
+- specfile:
+ * update copyright year
+
+- update to version 1.0.11:
+ * Fix the width of linenos table column when used in code-blocks.
+
+-------------------------------------------------------------------
+Mon Oct 14 14:15:59 UTC 2019 - Matej Cepl <[email protected]>
+
+- Replace %fdupes -s with plain %fdupes; hardlinks are better.
+
+-------------------------------------------------------------------
+Thu Feb 7 15:55:46 UTC 2019 - Hans-Peter Jansen <[email protected]>
+
+- Update to version 1.0.10 (2018-09-25)
+ + Add Read the Docs to the recipients of ad revenue.
+
+- Update to version 1.0.9 (2018-09-23)
+ + Remove hyphenation because it sometimes hyphenates
+ inappropriately, such as in code.
+
+- Update to version 1.0.8 (2018-09-21)
+ + Fix support for Ethical Ads.
+
+- Update to version 1.0.7 (2018-09-21)
+ + Added support for Ethical Ads for Read The Docs.
+ See https://github.com/Pylons/pylons-sphinx-themes/pull/12
+
+-------------------------------------------------------------------
+Tue Dec 4 12:52:27 UTC 2018 - Matej Cepl <[email protected]>
+
+- Remove superfluous devel dependency for noarch package
+
+-------------------------------------------------------------------
Old:
----
pylons-sphinx-themes-1.0.6.tar.gz
New:
----
pylons-sphinx-themes-1.0.11.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-pylons-sphinx-themes.spec ++++++
--- /var/tmp/diff_new_pack.S9E58w/_old 2020-03-02 13:21:05.154127408 +0100
+++ /var/tmp/diff_new_pack.S9E58w/_new 2020-03-02 13:21:05.182127464 +0100
@@ -1,7 +1,7 @@
#
# spec file for package python-pylons-sphinx-themes
#
-# Copyright (c) 2018 SUSE LINUX GmbH, Nuernberg, Germany.
+# Copyright (c) 2020 SUSE LLC
# Copyright (c) 2015 LISA GmbH, Bingen, Germany.
#
# All modifications and additions to the file contributed by third parties
@@ -13,37 +13,34 @@
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.
-# Please submit bugfixes or comments via http://bugs.opensuse.org/
+# Please submit bugfixes or comments via https://bugs.opensuse.org/
#
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
%define oldpython python
Name: python-pylons-sphinx-themes
-Version: 1.0.6
+Version: 1.0.11
Release: 0
Summary: Pylons Sphinx themes for documentation styling
License: SUSE-Repoze
-Group: Development/Languages/Python
-Url: https://github.com/Pylons/pylons-sphinx-themes
+URL: https://github.com/Pylons/pylons-sphinx-themes
Source:
https://files.pythonhosted.org/packages/source/p/pylons-sphinx-themes/pylons-sphinx-themes-%{version}.tar.gz
-BuildRequires: %{python_module devel}
BuildRequires: %{python_module setuptools}
BuildRequires: fdupes
BuildRequires: python-rpm-macros
Requires: python-Pygments
+Obsoletes: python-pylons_sphinx_theme < %{version}
+Provides: python-pylons_sphinx_theme = %{version}
+Obsoletes: python-pylons_theme_support < %{version}
+Provides: python-pylons_theme_support = %{version}
+BuildArch: noarch
%ifpython2
Obsoletes: %{oldpython}-pylons_sphinx_theme < %{version}
Provides: %{oldpython}-pylons_sphinx_theme = %{version}
Obsoletes: %{oldpython}-pylons_theme_support < %{version}
Provides: %{oldpython}-pylons_theme_support = %{version}
%endif
-Obsoletes: python-pylons_sphinx_theme < %{version}
-Provides: python-pylons_sphinx_theme = %{version}
-Obsoletes: python-pylons_theme_support < %{version}
-Provides: python-pylons_theme_support = %{version}
-BuildArch: noarch
-
%python_subpackages
%description
@@ -62,11 +59,11 @@
%install
%python_install
-%python_expand %fdupes -s %{buildroot}%{$python_sitelib}
+%python_expand %fdupes %{buildroot}%{$python_sitelib}
%files %{python_files}
-%defattr(-,root,root,-)
-%doc CHANGES.txt CONTRIBUTORS.txt LICENSE.txt README.md
+%license LICENSE.txt
+%doc CHANGES.txt CONTRIBUTORS.txt README.md
%{python_sitelib}/pylons_sphinx_themes
%{python_sitelib}/pylons_sphinx_themes-%{version}-py*.egg-info
++++++ pylons-sphinx-themes-1.0.6.tar.gz -> pylons-sphinx-themes-1.0.11.tar.gz
++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pylons-sphinx-themes-1.0.6/.gitignore
new/pylons-sphinx-themes-1.0.11/.gitignore
--- old/pylons-sphinx-themes-1.0.6/.gitignore 2017-09-22 22:46:47.000000000
+0200
+++ new/pylons-sphinx-themes-1.0.11/.gitignore 1970-01-01 01:00:00.000000000
+0100
@@ -1,12 +0,0 @@
-*.egg
-*.egg-info
-*.pyc
-*.pt.py
-*.txt.py
-.coverage
-.DS_Store
-.idea
-build/
-dist/
-env2*
-env3*
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pylons-sphinx-themes-1.0.6/CHANGES.txt
new/pylons-sphinx-themes-1.0.11/CHANGES.txt
--- old/pylons-sphinx-themes-1.0.6/CHANGES.txt 2017-09-22 22:46:47.000000000
+0200
+++ new/pylons-sphinx-themes-1.0.11/CHANGES.txt 2020-01-13 09:47:04.000000000
+0100
@@ -1,6 +1,38 @@
Change log for pylons-sphinx-themes
===================================
+1.0.11 (2020-01-13)
+-------------------
+
+- Fix the width of linenos table column when used in code-blocks.
+
+
+1.0.10 (2018-09-25)
+-------------------
+
+- Add Read the Docs to the recipients of ad revenue.
+
+
+1.0.9 (2018-09-23)
+------------------
+
+- Remove hyphenation because it sometimes hyphenates inappropriately, such as
+ in code.
+
+
+1.0.8 (2018-09-21)
+------------------
+
+- Fix support for Ethical Ads.
+
+
+1.0.7 (2018-09-21)
+------------------
+
+- Added support for Ethical Ads for Read The Docs. See
+ https://github.com/Pylons/pylons-sphinx-themes/pull/12
+
+
1.0.6 (2017-09-22)
------------------
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pylons-sphinx-themes-1.0.6/PKG-INFO
new/pylons-sphinx-themes-1.0.11/PKG-INFO
--- old/pylons-sphinx-themes-1.0.6/PKG-INFO 2017-09-22 22:46:48.000000000
+0200
+++ new/pylons-sphinx-themes-1.0.11/PKG-INFO 2020-01-13 09:47:04.000000000
+0100
@@ -1,12 +1,13 @@
-Metadata-Version: 1.1
+Metadata-Version: 1.2
Name: pylons-sphinx-themes
-Version: 1.0.6
+Version: 1.0.11
Summary: Sphinx themes for Pylons Project documentation.
Home-page: https://pylonsproject.org
Author: Steve Piercy
Author-email: [email protected]
License: BSD-derived (http://www.repoze.org/LICENSE.txt)
-Description-Content-Type: UNKNOWN
+Project-URL: Documentation,
https://github.com/Pylons/pylons-sphinx-themes#pylons-sphinx-themes
+Project-URL: Issue Tracker,
https://github.com/Pylons/pylons-sphinx-themes/issues
Description: Pylons Sphinx Themes
====================
@@ -17,77 +18,93 @@
Edit your project's ``setup.py``
--------------------------------
- #. Add ``pylons-sphinx-themes`` to your project's requirements in its
``setup.py``. Here's an example from Pyramid.
+ #. Add ``pylons-sphinx-themes`` to your project's requirements in its
``setup.py``.
+ Here's an example from Pyramid.
- .. code-block:: python
+ .. code-block:: python
- docs_extras = [
- 'Sphinx >= 1.3.1', # Read The Docs minimum version
- 'docutils',
- 'repoze.sphinx.autointerface',
- 'pylons-sphinx-themes',
- ]
+ docs_extras = [
+ 'Sphinx >= 1.7.5', # Read The Docs minimum version
+ 'docutils',
+ 'repoze.sphinx.autointerface',
+ 'pylons-sphinx-themes',
+ ]
Edit your Sphinx's ``conf.py``
------------------------------
- #. Near the top, add the following.
+ #. Near the top, add the following.
+
+ .. code-block:: python
+
+ import pylons_sphinx_themes
- .. code-block:: python
+ #. Activate the theme.
- import pylons_sphinx_themes
+ .. code-block:: python
- #. Activate the theme.
+ html_theme = 'pyramid'
+ html_theme_path = pylons_sphinx_themes.get_html_themes_path()
- .. code-block:: python
+ #. (Recommended) Enable `Ethical Ads
<https://docs.readthedocs.io/en/latest/advertising/ethical-advertising.html>`_.
+ Doing so supports both `Read the Docs <https://readthedocs.org/>`_
and the `Python Software Foundation <https://www.python.org/psf-landing/>`_
with ad revenue.
- html_theme = 'pyramid'
- html_theme_path = pylons_sphinx_themes.get_html_themes_path()
+ .. code-block:: python
- #. If you were previously using the git submodule method to use the
Pylons theme, then comment or delete the block of code under the following
statement.
+ # Control display of sidebars
+ html_sidebars = { '**': [
+ 'localtoc.html',
+ 'ethicalads.html',
+ 'relations.html',
+ 'sourcelink.html',
+ 'searchbox.html',
+ ] }
- .. code-block:: python
+ #. If you were previously using the git submodule method to use the
Pylons theme, then comment or delete the block of code under the following
statement.
- # Add and use Pylons theme
- if 'sphinx-build' in ' '.join(sys.argv): # protect against
dumb importers
+ .. code-block:: python
- #. (Optional) Set a canonical root URL. The URL points to the root of
the documentation, and requires a trailing slash.
+ # Add and use Pylons theme
+ if 'sphinx-build' in ' '.join(sys.argv): # protect against
dumb importers
- .. code-block:: python
+ #. (Optional) Set a canonical root URL.
+ The URL points to the root of the documentation, and requires a
trailing slash.
- html_theme_options = dict(
- canonical_url='http://the_root_domain/latest/docs/'
- )
+ .. code-block:: python
+
+ html_theme_options = dict(
+ canonical_url='http://the_root_domain/latest/docs/'
+ )
Undo git submodule method
-------------------------
If you were previously using the git submodule method to use the
Pylons theme, then perform the following additional steps.
- #. Remove ``.gitmodules``.
+ #. Remove ``.gitmodules``.
- .. code-block:: bash
+ .. code-block:: bash
- cd <your_project_directory>
- git rm .gitmodules
+ cd <your_project_directory>
+ git rm .gitmodules
- #. Deinitialize the submodule.
+ #. Deinitialize the submodule.
- .. code-block:: bash
+ .. code-block:: bash
- cd docs/_themes
- git submodule deinit .
+ cd docs/_themes
+ git submodule deinit .
- #. Remove the submodule's directory.
+ #. Remove the submodule's directory.
- .. code-block:: bash
+ .. code-block:: bash
- cd ..
- git rm _themes/
+ cd ..
+ git rm _themes/
- #. Edit your Sphinx's ``Makefile``. The following is an `example diff
<https://github.com/Pylons/pyramid/pull/1636/files>`_ from Pyramid.
+ #. Edit your Sphinx's ``Makefile``. The following is an `example diff
<https://github.com/Pylons/pyramid/pull/1636/files>`_ from Pyramid.
- .. code-block:: diff
+ .. code-block:: diff
-html: themes
+html:
@@ -106,19 +123,19 @@
.. code-block:: ini
docs_extras = [
- 'Sphinx >= 1.3.1',
+ 'Sphinx >= 1.7.5',
'docutils',
'repoze.sphinx.autointerface',
'pylons_sphinx_latesturl',
'pylons-sphinx-themes',
- ]
+ ]
# ...
extras_require = {
'testing':testing_extras,
'docs':docs_extras,
- },
+ },
Otherwise you can repeat yourself and edit your ``tox.ini``. The
following example is from `waitress
<https://github.com/Pylons/waitress/blob/master/tox.ini#L28>`_.
@@ -156,6 +173,38 @@
Change log for pylons-sphinx-themes
===================================
+ 1.0.11 (2020-01-13)
+ -------------------
+
+ - Fix the width of linenos table column when used in code-blocks.
+
+
+ 1.0.10 (2018-09-25)
+ -------------------
+
+ - Add Read the Docs to the recipients of ad revenue.
+
+
+ 1.0.9 (2018-09-23)
+ ------------------
+
+ - Remove hyphenation because it sometimes hyphenates inappropriately,
such as
+ in code.
+
+
+ 1.0.8 (2018-09-21)
+ ------------------
+
+ - Fix support for Ethical Ads.
+
+
+ 1.0.7 (2018-09-21)
+ ------------------
+
+ - Added support for Ethical Ads for Read The Docs. See
+ https://github.com/Pylons/pylons-sphinx-themes/pull/12
+
+
1.0.6 (2017-09-22)
------------------
@@ -230,6 +279,8 @@
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pylons-sphinx-themes-1.0.6/README.md
new/pylons-sphinx-themes-1.0.11/README.md
--- old/pylons-sphinx-themes-1.0.6/README.md 2017-09-22 22:46:47.000000000
+0200
+++ new/pylons-sphinx-themes-1.0.11/README.md 2020-01-13 09:47:04.000000000
+0100
@@ -9,23 +9,23 @@
To use a theme in your Sphinx documentation, follow this guide.
-Edit your project's `setup.py`
-------------------------------
+Edit your project\'s `setup.py`
+-------------------------------
-1. Add `pylons-sphinx-themes` to your project's requirements in its
- `setup.py`. Here's an example from Pyramid.
+1. Add `pylons-sphinx-themes` to your project\'s requirements in its
+ `setup.py`. Here\'s an example from Pyramid.
``` {.sourceCode .python}
docs_extras = [
- 'Sphinx >= 1.3.1', # Read The Docs minimum version
+ 'Sphinx >= 1.7.5', # Read The Docs minimum version
'docutils',
'repoze.sphinx.autointerface',
'pylons-sphinx-themes',
- ]
+ ]
```
-Edit your Sphinx's `conf.py`
-----------------------------
+Edit your Sphinx\'s `conf.py`
+-----------------------------
1. Near the top, add the following.
@@ -40,7 +40,24 @@
html_theme_path = pylons_sphinx_themes.get_html_themes_path()
```
-3. If you were previously using the git submodule method to use the
+3. (Recommended) Enable [Ethical
+
Ads](https://docs.readthedocs.io/en/latest/advertising/ethical-advertising.html).
+ Doing so supports both [Read the Docs](https://readthedocs.org/) and
+ the [Python Software
+ Foundation](https://www.python.org/psf-landing/) with ad revenue.
+
+ ``` {.sourceCode .python}
+ # Control display of sidebars
+ html_sidebars = { '**': [
+ 'localtoc.html',
+ 'ethicalads.html',
+ 'relations.html',
+ 'sourcelink.html',
+ 'searchbox.html',
+ ] }
+ ```
+
+4. If you were previously using the git submodule method to use the
Pylons theme, then comment or delete the block of code under the
following statement.
@@ -49,7 +66,7 @@
if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers
```
-4. (Optional) Set a canonical root URL. The URL points to the root of
+5. (Optional) Set a canonical root URL. The URL points to the root of
the documentation, and requires a trailing slash.
``` {.sourceCode .python}
@@ -78,14 +95,14 @@
git submodule deinit .
```
-3. Remove the submodule's directory.
+3. Remove the submodule\'s directory.
``` {.sourceCode .bash}
cd ..
git rm _themes/
```
-4. Edit your Sphinx's `Makefile`. The following is an [example
+4. Edit your Sphinx\'s `Makefile`. The following is an [example
diff](https://github.com/Pylons/pyramid/pull/1636/files) from
Pyramid.
@@ -110,19 +127,19 @@
``` {.sourceCode .ini}
docs_extras = [
- 'Sphinx >= 1.3.1',
+ 'Sphinx >= 1.7.5',
'docutils',
'repoze.sphinx.autointerface',
'pylons_sphinx_latesturl',
'pylons-sphinx-themes',
- ]
+]
# ...
extras_require = {
'testing':testing_extras,
'docs':docs_extras,
- },
+},
```
Otherwise you can repeat yourself and edit your `tox.ini`. The following
@@ -160,4 +177,3 @@
- **pylons** - the generic Pylons Project documentation theme
- **pyramid** - the specific Pyramid documentation theme
- **pylonsfw** - the specific Pylons Framework documentation theme
-
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pylons-sphinx-themes-1.0.6/README.rst
new/pylons-sphinx-themes-1.0.11/README.rst
--- old/pylons-sphinx-themes-1.0.6/README.rst 2017-09-22 22:46:47.000000000
+0200
+++ new/pylons-sphinx-themes-1.0.11/README.rst 2020-01-13 09:47:04.000000000
+0100
@@ -8,77 +8,93 @@
Edit your project's ``setup.py``
--------------------------------
-#. Add ``pylons-sphinx-themes`` to your project's requirements in its
``setup.py``. Here's an example from Pyramid.
+#. Add ``pylons-sphinx-themes`` to your project's requirements in its
``setup.py``.
+ Here's an example from Pyramid.
- .. code-block:: python
+ .. code-block:: python
- docs_extras = [
- 'Sphinx >= 1.3.1', # Read The Docs minimum version
- 'docutils',
- 'repoze.sphinx.autointerface',
- 'pylons-sphinx-themes',
- ]
+ docs_extras = [
+ 'Sphinx >= 1.7.5', # Read The Docs minimum version
+ 'docutils',
+ 'repoze.sphinx.autointerface',
+ 'pylons-sphinx-themes',
+ ]
Edit your Sphinx's ``conf.py``
------------------------------
-#. Near the top, add the following.
+#. Near the top, add the following.
+
+ .. code-block:: python
+
+ import pylons_sphinx_themes
- .. code-block:: python
+#. Activate the theme.
- import pylons_sphinx_themes
+ .. code-block:: python
-#. Activate the theme.
+ html_theme = 'pyramid'
+ html_theme_path = pylons_sphinx_themes.get_html_themes_path()
- .. code-block:: python
+#. (Recommended) Enable `Ethical Ads
<https://docs.readthedocs.io/en/latest/advertising/ethical-advertising.html>`_.
+ Doing so supports both `Read the Docs <https://readthedocs.org/>`_ and the
`Python Software Foundation <https://www.python.org/psf-landing/>`_ with ad
revenue.
- html_theme = 'pyramid'
- html_theme_path = pylons_sphinx_themes.get_html_themes_path()
+ .. code-block:: python
-#. If you were previously using the git submodule method to use the Pylons
theme, then comment or delete the block of code under the following statement.
+ # Control display of sidebars
+ html_sidebars = { '**': [
+ 'localtoc.html',
+ 'ethicalads.html',
+ 'relations.html',
+ 'sourcelink.html',
+ 'searchbox.html',
+ ] }
- .. code-block:: python
+#. If you were previously using the git submodule method to use the Pylons
theme, then comment or delete the block of code under the following statement.
- # Add and use Pylons theme
- if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb
importers
+ .. code-block:: python
-#. (Optional) Set a canonical root URL. The URL points to the root of the
documentation, and requires a trailing slash.
+ # Add and use Pylons theme
+ if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb
importers
- .. code-block:: python
+#. (Optional) Set a canonical root URL.
+ The URL points to the root of the documentation, and requires a trailing
slash.
- html_theme_options = dict(
- canonical_url='http://the_root_domain/latest/docs/'
- )
+ .. code-block:: python
+
+ html_theme_options = dict(
+ canonical_url='http://the_root_domain/latest/docs/'
+ )
Undo git submodule method
-------------------------
If you were previously using the git submodule method to use the Pylons theme,
then perform the following additional steps.
-#. Remove ``.gitmodules``.
+#. Remove ``.gitmodules``.
- .. code-block:: bash
+ .. code-block:: bash
- cd <your_project_directory>
- git rm .gitmodules
+ cd <your_project_directory>
+ git rm .gitmodules
-#. Deinitialize the submodule.
+#. Deinitialize the submodule.
- .. code-block:: bash
+ .. code-block:: bash
- cd docs/_themes
- git submodule deinit .
+ cd docs/_themes
+ git submodule deinit .
-#. Remove the submodule's directory.
+#. Remove the submodule's directory.
- .. code-block:: bash
+ .. code-block:: bash
- cd ..
- git rm _themes/
+ cd ..
+ git rm _themes/
-#. Edit your Sphinx's ``Makefile``. The following is an `example diff
<https://github.com/Pylons/pyramid/pull/1636/files>`_ from Pyramid.
+#. Edit your Sphinx's ``Makefile``. The following is an `example diff
<https://github.com/Pylons/pyramid/pull/1636/files>`_ from Pyramid.
- .. code-block:: diff
+ .. code-block:: diff
-html: themes
+html:
@@ -97,19 +113,19 @@
.. code-block:: ini
docs_extras = [
- 'Sphinx >= 1.3.1',
+ 'Sphinx >= 1.7.5',
'docutils',
'repoze.sphinx.autointerface',
'pylons_sphinx_latesturl',
'pylons-sphinx-themes',
- ]
+ ]
# ...
extras_require = {
'testing':testing_extras,
'docs':docs_extras,
- },
+ },
Otherwise you can repeat yourself and edit your ``tox.ini``. The following
example is from `waitress
<https://github.com/Pylons/waitress/blob/master/tox.ini#L28>`_.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pylons-sphinx-themes-1.0.6/contributing.md
new/pylons-sphinx-themes-1.0.11/contributing.md
--- old/pylons-sphinx-themes-1.0.6/contributing.md 2017-09-22
22:46:47.000000000 +0200
+++ new/pylons-sphinx-themes-1.0.11/contributing.md 2020-01-13
09:47:04.000000000 +0100
@@ -1,10 +1,25 @@
-Contributing
-============
+# Contributing
-All projects under the Pylons Projects, including this one, follow the
guidelines established at [How to
Contribute](https://pylonsproject.org/community-how-to-contribute.html) and
[Coding Style and
Standards](https://pylonsproject.org/community-coding-style-standards.html).
+All projects under the Pylons Project, including this one, follow the
guidelines established at [How to
Contribute](https://pylonsproject.org/community-how-to-contribute.html),
[Coding Style and
Standards](https://pylonsproject.org/community-coding-style-standards.html),
and [Pylons Project Documentation Style
Guide](https://docs.pylonsproject.org/projects/docs-style-guide/).
You can contribute to this project in several ways.
-* [File an Issue on
GitHub](https://github.com/Pylons/pylons-sphinx-themes/issues)
-* Fork this project and create a branch with your suggested change. When
ready, submit a pull request for consideration. [GitHub
Flow](https://guides.github.com/introduction/flow/index.html) describes the
workflow process and why it's a good practice. When submitting a pull request,
sign
[CONTRIBUTORS.txt](https://github.com/Pylons/pylons-sphinx-themes/blob/master/CONTRIBUTORS.txt)
if you have not yet done so.
-* Join the IRC channel #pyramid on irc.freenode.net.
+* [File an Issue on
GitHub](https://github.com/Pylons/pylons-sphinx-themes/issues).
+* Fork this project, create a new branch, commit your suggested change, and
push to your fork on GitHub.
+ When ready, submit a pull request for consideration.
+ [GitHub Flow](https://guides.github.com/introduction/flow/index.html)
describes the workflow process and why it's a good practice.
+ When submitting a pull request, sign
[CONTRIBUTORS.txt](https://github.com/Pylons/pylons-sphinx-themes/blob/master/CONTRIBUTORS.txt)
if you have not yet done so.
+* Join the [IRC channel #pyramid on
irc.freenode.net](https://webchat.freenode.net/?channels=pyramid).
+
+## Git Branches
+
+Git branches and their purpose and status at the time of this writing are
listed below.
+
+* [master](https://github.com/Pylons/pylons-sphinx-themes/) - The branch
which should always be *deployable*.
+ The default branch on GitHub.
+* For development, create a new branch.
+ If changes on your new branch are accepted, they will be merged into the
master branch and deployed.
+
+## Prerequisites
+
+Follow the instructions in
[README.rst](https://github.com/Pylons/pylons-sphinx-themes/) to install the
tools needed to run the project.
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/pylons-sphinx-themes-1.0.6/pylons_sphinx_themes/pylons/ethicalads.html
new/pylons-sphinx-themes-1.0.11/pylons_sphinx_themes/pylons/ethicalads.html
--- old/pylons-sphinx-themes-1.0.6/pylons_sphinx_themes/pylons/ethicalads.html
1970-01-01 01:00:00.000000000 +0100
+++ new/pylons-sphinx-themes-1.0.11/pylons_sphinx_themes/pylons/ethicalads.html
2020-01-13 09:47:04.000000000 +0100
@@ -0,0 +1,2 @@
+<!-- Ethical ad insertion -->
+<div id="ethical-ad-placement"></div>
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/pylons-sphinx-themes-1.0.6/pylons_sphinx_themes/pylons/static/pylons.css_t
new/pylons-sphinx-themes-1.0.11/pylons_sphinx_themes/pylons/static/pylons.css_t
---
old/pylons-sphinx-themes-1.0.6/pylons_sphinx_themes/pylons/static/pylons.css_t
2017-09-22 22:46:47.000000000 +0200
+++
new/pylons-sphinx-themes-1.0.11/pylons_sphinx_themes/pylons/static/pylons.css_t
2020-01-13 09:47:04.000000000 +0100
@@ -172,7 +172,7 @@
}
div.sphinxsidebar input[type=text]{
- margin-left: 20px;
+ margin-left: 10px;
}
/* -- sidebars --------------------------------------------------------------
*/
@@ -192,6 +192,40 @@
font-weight: bold;
}
+form.search {
+ height: 50px;
+}
+div.sphinxsidebar #searchbox input[type="submit"] {
+ width: 10%;
+}
+
+div.sphinxsidebar .ethical-text, div.sphinxsidebar .ethical-callout {
+ color: #444;
+ text-align: center;
+}
+
+div.sphinxsidebar .ethical-text {
+ padding: 5px 10px 0px;
+}
+
+div.sphinxsidebar .ethical-callout {
+ padding: 5px 10px 5px;
+}
+
+div.sphinxsidebar div.ethical-text a,
+div.sphinxsidebar div.ethical-callout a {
+ color: #222;
+ text-decoration: none;
+ border-bottom: 1px dotted #999;
+}
+
+div.sphinxsidebar div.ethical-text a:hover,
+div.sphinxsidebar div.ethical-callout a:hover {
+ color: #000;
+ text-decoration: none;
+ border-bottom: 1px solid #999;
+}
+
/* -- body styles -----------------------------------------------------------
*/
a, a .pre {
@@ -350,6 +384,10 @@
padding: 0;
}
+table.highlighttable td.linenos {
+ width: 2%;
+}
+
a em.std-term, a span.std-term {
color: #007f00;
}
@@ -490,3 +528,10 @@
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffee5f5b',
endColorstr='#ffbd362f', GradientType=0);
filter: progid:DXImageTransform.Microsoft.gradient(enabled=false);
}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/pylons-sphinx-themes-1.0.6/pylons_sphinx_themes.egg-info/PKG-INFO
new/pylons-sphinx-themes-1.0.11/pylons_sphinx_themes.egg-info/PKG-INFO
--- old/pylons-sphinx-themes-1.0.6/pylons_sphinx_themes.egg-info/PKG-INFO
2017-09-22 22:46:47.000000000 +0200
+++ new/pylons-sphinx-themes-1.0.11/pylons_sphinx_themes.egg-info/PKG-INFO
2020-01-13 09:47:04.000000000 +0100
@@ -1,12 +1,13 @@
-Metadata-Version: 1.1
+Metadata-Version: 1.2
Name: pylons-sphinx-themes
-Version: 1.0.6
+Version: 1.0.11
Summary: Sphinx themes for Pylons Project documentation.
Home-page: https://pylonsproject.org
Author: Steve Piercy
Author-email: [email protected]
License: BSD-derived (http://www.repoze.org/LICENSE.txt)
-Description-Content-Type: UNKNOWN
+Project-URL: Documentation,
https://github.com/Pylons/pylons-sphinx-themes#pylons-sphinx-themes
+Project-URL: Issue Tracker,
https://github.com/Pylons/pylons-sphinx-themes/issues
Description: Pylons Sphinx Themes
====================
@@ -17,77 +18,93 @@
Edit your project's ``setup.py``
--------------------------------
- #. Add ``pylons-sphinx-themes`` to your project's requirements in its
``setup.py``. Here's an example from Pyramid.
+ #. Add ``pylons-sphinx-themes`` to your project's requirements in its
``setup.py``.
+ Here's an example from Pyramid.
- .. code-block:: python
+ .. code-block:: python
- docs_extras = [
- 'Sphinx >= 1.3.1', # Read The Docs minimum version
- 'docutils',
- 'repoze.sphinx.autointerface',
- 'pylons-sphinx-themes',
- ]
+ docs_extras = [
+ 'Sphinx >= 1.7.5', # Read The Docs minimum version
+ 'docutils',
+ 'repoze.sphinx.autointerface',
+ 'pylons-sphinx-themes',
+ ]
Edit your Sphinx's ``conf.py``
------------------------------
- #. Near the top, add the following.
+ #. Near the top, add the following.
+
+ .. code-block:: python
+
+ import pylons_sphinx_themes
- .. code-block:: python
+ #. Activate the theme.
- import pylons_sphinx_themes
+ .. code-block:: python
- #. Activate the theme.
+ html_theme = 'pyramid'
+ html_theme_path = pylons_sphinx_themes.get_html_themes_path()
- .. code-block:: python
+ #. (Recommended) Enable `Ethical Ads
<https://docs.readthedocs.io/en/latest/advertising/ethical-advertising.html>`_.
+ Doing so supports both `Read the Docs <https://readthedocs.org/>`_
and the `Python Software Foundation <https://www.python.org/psf-landing/>`_
with ad revenue.
- html_theme = 'pyramid'
- html_theme_path = pylons_sphinx_themes.get_html_themes_path()
+ .. code-block:: python
- #. If you were previously using the git submodule method to use the
Pylons theme, then comment or delete the block of code under the following
statement.
+ # Control display of sidebars
+ html_sidebars = { '**': [
+ 'localtoc.html',
+ 'ethicalads.html',
+ 'relations.html',
+ 'sourcelink.html',
+ 'searchbox.html',
+ ] }
- .. code-block:: python
+ #. If you were previously using the git submodule method to use the
Pylons theme, then comment or delete the block of code under the following
statement.
- # Add and use Pylons theme
- if 'sphinx-build' in ' '.join(sys.argv): # protect against
dumb importers
+ .. code-block:: python
- #. (Optional) Set a canonical root URL. The URL points to the root of
the documentation, and requires a trailing slash.
+ # Add and use Pylons theme
+ if 'sphinx-build' in ' '.join(sys.argv): # protect against
dumb importers
- .. code-block:: python
+ #. (Optional) Set a canonical root URL.
+ The URL points to the root of the documentation, and requires a
trailing slash.
- html_theme_options = dict(
- canonical_url='http://the_root_domain/latest/docs/'
- )
+ .. code-block:: python
+
+ html_theme_options = dict(
+ canonical_url='http://the_root_domain/latest/docs/'
+ )
Undo git submodule method
-------------------------
If you were previously using the git submodule method to use the
Pylons theme, then perform the following additional steps.
- #. Remove ``.gitmodules``.
+ #. Remove ``.gitmodules``.
- .. code-block:: bash
+ .. code-block:: bash
- cd <your_project_directory>
- git rm .gitmodules
+ cd <your_project_directory>
+ git rm .gitmodules
- #. Deinitialize the submodule.
+ #. Deinitialize the submodule.
- .. code-block:: bash
+ .. code-block:: bash
- cd docs/_themes
- git submodule deinit .
+ cd docs/_themes
+ git submodule deinit .
- #. Remove the submodule's directory.
+ #. Remove the submodule's directory.
- .. code-block:: bash
+ .. code-block:: bash
- cd ..
- git rm _themes/
+ cd ..
+ git rm _themes/
- #. Edit your Sphinx's ``Makefile``. The following is an `example diff
<https://github.com/Pylons/pyramid/pull/1636/files>`_ from Pyramid.
+ #. Edit your Sphinx's ``Makefile``. The following is an `example diff
<https://github.com/Pylons/pyramid/pull/1636/files>`_ from Pyramid.
- .. code-block:: diff
+ .. code-block:: diff
-html: themes
+html:
@@ -106,19 +123,19 @@
.. code-block:: ini
docs_extras = [
- 'Sphinx >= 1.3.1',
+ 'Sphinx >= 1.7.5',
'docutils',
'repoze.sphinx.autointerface',
'pylons_sphinx_latesturl',
'pylons-sphinx-themes',
- ]
+ ]
# ...
extras_require = {
'testing':testing_extras,
'docs':docs_extras,
- },
+ },
Otherwise you can repeat yourself and edit your ``tox.ini``. The
following example is from `waitress
<https://github.com/Pylons/waitress/blob/master/tox.ini#L28>`_.
@@ -156,6 +173,38 @@
Change log for pylons-sphinx-themes
===================================
+ 1.0.11 (2020-01-13)
+ -------------------
+
+ - Fix the width of linenos table column when used in code-blocks.
+
+
+ 1.0.10 (2018-09-25)
+ -------------------
+
+ - Add Read the Docs to the recipients of ad revenue.
+
+
+ 1.0.9 (2018-09-23)
+ ------------------
+
+ - Remove hyphenation because it sometimes hyphenates inappropriately,
such as
+ in code.
+
+
+ 1.0.8 (2018-09-21)
+ ------------------
+
+ - Fix support for Ethical Ads.
+
+
+ 1.0.7 (2018-09-21)
+ ------------------
+
+ - Added support for Ethical Ads for Read The Docs. See
+ https://github.com/Pylons/pylons-sphinx-themes/pull/12
+
+
1.0.6 (2017-09-22)
------------------
@@ -230,6 +279,8 @@
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/pylons-sphinx-themes-1.0.6/pylons_sphinx_themes.egg-info/SOURCES.txt
new/pylons-sphinx-themes-1.0.11/pylons_sphinx_themes.egg-info/SOURCES.txt
--- old/pylons-sphinx-themes-1.0.6/pylons_sphinx_themes.egg-info/SOURCES.txt
2017-09-22 22:46:47.000000000 +0200
+++ new/pylons-sphinx-themes-1.0.11/pylons_sphinx_themes.egg-info/SOURCES.txt
2020-01-13 09:47:04.000000000 +0100
@@ -1,4 +1,3 @@
-.gitignore
CHANGES.txt
CONTRIBUTORS.txt
COPYRIGHT.txt
@@ -17,6 +16,7 @@
pylons_sphinx_themes.egg-info/dependency_links.txt
pylons_sphinx_themes.egg-info/not-zip-safe
pylons_sphinx_themes.egg-info/top_level.txt
+pylons_sphinx_themes/pylons/ethicalads.html
pylons_sphinx_themes/pylons/layout.html
pylons_sphinx_themes/pylons/theme.conf
pylons_sphinx_themes/pylons/static/dialog-note.png
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pylons-sphinx-themes-1.0.6/setup.py
new/pylons-sphinx-themes-1.0.11/setup.py
--- old/pylons-sphinx-themes-1.0.6/setup.py 2017-09-22 22:46:47.000000000
+0200
+++ new/pylons-sphinx-themes-1.0.11/setup.py 2020-01-13 09:47:04.000000000
+0100
@@ -16,7 +16,7 @@
from setuptools import setup, find_packages
-VERSION = '1.0.6'
+VERSION = '1.0.11'
here = os.path.abspath(os.path.dirname(__file__))
try:
@@ -45,6 +45,8 @@
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
+ 'Programming Language :: Python :: 3.7',
+ 'Programming Language :: Python :: 3.8',
'Topic :: Documentation',
'Topic :: Documentation :: Sphinx',
'Topic :: Software Development :: Documentation',
@@ -53,6 +55,12 @@
author='Steve Piercy',
author_email='[email protected]',
url='https://pylonsproject.org',
+ project_urls={
+ 'Documentation':
+
'https://github.com/Pylons/pylons-sphinx-themes#pylons-sphinx-themes',
+ 'Issue Tracker':
+ 'https://github.com/Pylons/pylons-sphinx-themes/issues',
+ },
license='BSD-derived (http://www.repoze.org/LICENSE.txt)',
packages=find_packages(),
include_package_data=True,