Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit b34c283

Browse files
stsewdstsewd
authored
Merge pull request #53 from readthedocs/prepare-release
Prepare 0.1.0rc1 release
2 parents faa85a9 + b1796ff commit b34c283

File tree

12 files changed

+30
-63
lines changed

12 files changed

+30
-63
lines changed

‎README.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
readthedocs-sphinx-search
22
=========================
33

4-
|docs| |license| |build-status|
4+
|pypi| |docs| |license| |build-status|
55

6-
Sphinx extension to enable `search as you type` feature for docs hosted by Read the Docs.
6+
`Sphinx`_ extension to enable *search as you type* within a full-page search UI for docs hosted on `Read the Docs`_.
7+
Try it at https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing.
78

9+
.. _Sphinx: https://www.sphinx-doc.org/
10+
.. _Read the Docs: https://readthedocs.org/
811

912
Installation
1013
------------
1114

1215
::
1316

14-
pip install git+https://github.com/readthedocs/readthedocs-sphinx-search@master
17+
pip install readthedocs-sphinx-search
1518

1619

1720
Configuration
@@ -27,15 +30,8 @@ Add this extension in your ``conf.py`` file as:
2730
]
2831
2932
30-
Documentation
31-
-------------
32-
33-
Check out the full documentation at https://readthedocs-sphinx-search.readthedocs.io/
34-
35-
3633
.. |docs| image:: https://readthedocs.org/projects/readthedocs-sphinx-search/badge/?version=latest
3734
:alt: Documentation Status
38-
:scale: 100%
3935
:target: https://readthedocs-sphinx-search.readthedocs.io/en/latest/?badge=latest
4036

4137
.. |license| image:: https://img.shields.io/github/license/readthedocs/readthedocs-sphinx-search.svg
@@ -45,3 +41,8 @@ Check out the full documentation at https://readthedocs-sphinx-search.readthedoc
4541
.. |build-status| image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-search.svg?branch=master
4642
:alt: Build Status
4743
:target: https://travis-ci.org/readthedocs/readthedocs-sphinx-search
44+
45+
46+
.. |pypi| image:: https://img.shields.io/pypi/v/readthedocs-sphinx-search.svg
47+
:target: https://pypi.python.org/pypi/readthedocs-sphinx-search
48+
:alt: PyPI Version

‎docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
# The short X.Y version
2828
# The full version, including alpha/beta/rc tags
2929
import sphinx_search
30-
version = release = sphinx_search.version
30+
version = release = sphinx_search.__version__
3131

3232

3333
# -- General configuration ---------------------------------------------------

‎docs/index.rst

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,4 @@
1-
readthedocs-sphinx-search
2-
=========================
3-
4-
|docs| |license| |build-status|
5-
6-
``readthedocs-sphinx-search`` is a `Sphinx`_ extension which adds a
7-
**full-page search UI** with **search as you type** feature to your documentation.
8-
This extension is compatible with all the documentations hosted on `Read the Docs`_.
9-
10-
11-
In-Doc Search UI
12-
----------------
13-
14-
Using the existing search backend of `Read the Docs`_,
15-
this extension is designed to greatly improve the search experience
16-
of the reader.
17-
To experience it first hand, try searching in this documentation or visit here:
18-
https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing
19-
1+
.. include:: ../README.rst
202

213
.. toctree::
224
:maxdepth: 2
@@ -30,20 +12,3 @@ https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing
3012
testing
3113
js-api-reference
3214
get-involved
33-
34-
35-
.. _Sphinx: https://www.sphinx-doc.org/
36-
.. _Read the Docs: https://readthedocs.org
37-
38-
39-
.. |docs| image:: https://readthedocs.org/projects/readthedocs-sphinx-search/badge/?version=latest
40-
:alt: Documentation Status
41-
:target: https://readthedocs-sphinx-search.readthedocs.io/en/latest/?badge=latest
42-
43-
.. |license| image:: https://img.shields.io/github/license/readthedocs/readthedocs-sphinx-search.svg
44-
:target: LICENSE
45-
:alt: Repository license
46-
47-
.. |build-status| image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-search.svg?branch=master
48-
:alt: Build Status
49-
:target: https://travis-ci.org/readthedocs/readthedocs-sphinx-search

‎scripts/setup_chromedriver.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
wget -N https://chromedriver.storage.googleapis.com/81.0.4044.69/chromedriver_linux64.zip -P ~/
1+
wget -N https://chromedriver.storage.googleapis.com/83.0.4103.39/chromedriver_linux64.zip -P ~/
22
unzip ~/chromedriver_linux64.zip -d ~/
33
rm ~/chromedriver_linux64.zip
44
sudo mv -f ~/chromedriver /usr/local/bin/

‎setup.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,37 @@
11
import setuptools
2+
23
import sphinx_search
34

45

56
with open('README.rst', 'r') as fh:
67
long_description = fh.read()
78

9+
810
setuptools.setup(
9-
name='readthedocs_sphinx_search',
10-
version=sphinx_search.version,
11+
name='readthedocs-sphinx-search',
12+
version=sphinx_search.__version__,
1113
author='Vaibhav Gupta',
1214
author_email='[email protected]',
13-
description='Sphinx extension to enable `search as you type` for docs hosted by Read the Docs.',
15+
description='Sphinx extension to enable search as you type for docs hosted on Read the Docs.',
1416
url='https://github.com/readthedocs/readthedocs-sphinx-search',
1517
license='MIT',
1618
packages=setuptools.find_packages(),
1719
long_description=long_description,
1820
long_description_content_type='text/x-rst',
1921
include_package_data=True,
2022
zip_safe=False,
23+
keywords='sphinx search readthedocs',
24+
python_requires='>=3.6',
25+
project_urls={
26+
'Documentation': 'https://readthedocs-sphinx-search.readthedocs.io/',
27+
'Bug Reports': 'https://github.com/readthedocs/readthedocs-sphinx-search/issues',
28+
'Source': 'https://github.com/readthedocs/readthedocs-sphinx-search',
29+
},
2130
classifiers=[
31+
'Development Status :: 4 - Beta',
2232
'Programming Language :: Python :: 3',
2333
'License :: OSI Approved :: MIT License',
2434
'Operating System :: OS Independent',
35+
'Framework :: Sphinx :: Extension',
2536
],
2637
)

‎sphinx_search/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version = '0.1.dev0'
1+
__version__ = '0.1.0rc1'

‎tests/__init__.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
31
import os
42

53

‎tests/conftest.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
31
"""Pytest fixtures and other things."""
42

53
import os

‎tests/test_extension.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
31
"""Test working of extension."""
42

53
import os

‎tests/test_ui.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
31
"""UI tests."""
42

53
import os

‎tests/utils.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
31
"""Utils for testing."""
42

53
import os

‎tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ skipsdist = True
1010
description = run the whole test suite
1111
deps =
1212
.
13-
pytest-selenium
13+
pytest-selenium==1.17.0
1414
sphinx18: Sphinx<1.9
1515
sphinx20: Sphinx<2.1
1616
sphinx21: Sphinx<2.2

0 commit comments

Comments
 (0)