Browse Source

Renaming to `sphinx_sleekcat_theme`

rc1
miili 5 years ago
parent
commit
13fc367154
  1. 18
      README.rst
  2. 12
      setup.py
  3. 0
      src/sphinx_sleekcat_theme/__init__.py
  4. 0
      src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/globaltoc.html
  5. 0
      src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/layout.html
  6. 0
      src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/copybutton.js
  7. 0
      src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/favicon.png
  8. 0
      src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/pydoctheme.css_t
  9. 0
      src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/right-red@2x.png
  10. 0
      src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/sidebar.js
  11. 0
      src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/theme.conf

18
README.rst

@ -31,7 +31,7 @@ Enhanced Sphinx theme (based on Python 3 docs)
:alt: PyPI Package monthly downloads
:target: https://pypi.python.org/pypi/sphinx-py3doc-enhanced-theme
A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.
A theme based on https://github.com/ionelmc/sphinx-py3doc-enhanced-theme
* Free software: BSD license
@ -40,15 +40,15 @@ Installation
::
pip install sphinx_py3doc_enhanced_theme
pip install sphinx_sleekcat_theme
Add this in your documentation's ``conf.py``:
.. sourcecode:: python
import sphinx_py3doc_enhanced_theme
html_theme = "sphinx_py3doc_enhanced_theme"
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
import sphinx_sleekcat_theme
html_theme = "sphinx_sleekcat_theme"
html_theme_path = [sphinx_sleekcat_theme.get_html_theme_path()]
Customization
=============
@ -63,7 +63,7 @@ To get the original styling Python 3 docs have add this in you ``conf.py``:
.. sourcecode:: python
html_theme_options = {
'githuburl': 'https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/',
'githuburl': 'https://github.com/pyrocko/pyrocko/',
'bodyfont': '"Lucida Grande",Arial,sans-serif',
'headfont': '"Lucida Grande",Arial,sans-serif',
'codefont': 'monospace,sans-serif',
@ -83,7 +83,7 @@ To have a custom favicon create a ``theme`` directory near your ``conf.py`` and
.. sourcecode:: ini
[theme]
inherit = sphinx_py3doc_enhanced_theme
inherit = sphinx_sleekcat_theme
Then create a ``favicon.png`` in the ``static`` directory.
@ -91,9 +91,9 @@ And then edit your ``conf.py`` to have something like this:
.. sourcecode:: python
import sphinx_py3doc_enhanced_theme
import sphinx_sleekcat_theme
html_theme = "theme"
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path(), "."]
html_theme_path = [sphinx_sleekcat_theme.get_html_theme_path(), "."]
The final file structure should be like this::

12
setup.py

@ -23,14 +23,14 @@ def read(*names, **kwargs):
setup(
name='sphinx-py3doc-enhanced-theme',
version='2.4.0',
name='sphinx-sleekcat-theme',
version='0.1.0',
license='BSD',
description='A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.',
description='A theme based on the https://github.com/ionelmc/sphinx-py3doc-enhanced-theme',
long_description='%s\n%s' % (read('README.rst'), re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', read('CHANGELOG.rst'))),
author='Ionel Cristian Mărieș',
author='Pyrocko Developer Team',
author_email='contact@ionelmc.ro',
url='https://github.com/ionelmc/sphinx-py3doc-enhanced-theme',
url='https://github.com/pyrocko/spinx-sleekcat-theme',
packages=find_packages('src'),
package_dir={'': 'src'},
py_modules=[splitext(basename(path))[0] for path in glob('src/*.py')],
@ -56,7 +56,7 @@ setup(
],
entry_points = {
'sphinx_themes': [
'path = sphinx_py3doc_enhanced_theme:get_html_theme_path',
'path = sphinx_sleekcat_theme:get_html_theme_path',
]
},
keywords=[

0
src/sphinx_py3doc_enhanced_theme/__init__.py → src/sphinx_sleekcat_theme/__init__.py

0
src/sphinx_py3doc_enhanced_theme/themes/sphinx_py3doc_enhanced_theme/globaltoc.html → src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/globaltoc.html

0
src/sphinx_py3doc_enhanced_theme/themes/sphinx_py3doc_enhanced_theme/layout.html → src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/layout.html

0
src/sphinx_py3doc_enhanced_theme/themes/sphinx_py3doc_enhanced_theme/static/copybutton.js → src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/copybutton.js

0
src/sphinx_py3doc_enhanced_theme/themes/sphinx_py3doc_enhanced_theme/static/favicon.png → src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/favicon.png

Before

Width:  |  Height:  |  Size: 695 B

After

Width:  |  Height:  |  Size: 695 B

0
src/sphinx_py3doc_enhanced_theme/themes/sphinx_py3doc_enhanced_theme/static/pydoctheme.css_t → src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/pydoctheme.css_t

0
src/sphinx_py3doc_enhanced_theme/themes/sphinx_py3doc_enhanced_theme/static/right-red@2x.png → src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/right-red@2x.png

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

0
src/sphinx_py3doc_enhanced_theme/themes/sphinx_py3doc_enhanced_theme/static/sidebar.js → src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/static/sidebar.js

0
src/sphinx_py3doc_enhanced_theme/themes/sphinx_py3doc_enhanced_theme/theme.conf → src/sphinx_sleekcat_theme/themes/sphinx_sleekcat_theme/theme.conf

Loading…
Cancel
Save