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

Prepare 0.1.0rc1 release #53

Merged
merged 2 commits into from
Jun 9, 2020
Merged

Prepare 0.1.0rc1 release #53

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5839d48
Prepare 0.1.0rc1 release
stsewd Jun 9, 2020
b1796ff
Fix tests
stsewd Jun 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
readthedocs-sphinx-search
=========================

|docs| |license| |build-status|
|pypi| |docs| |license| |build-status|

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

.. _Sphinx: https://www.sphinx-doc.org/
.. _Read the Docs: https://readthedocs.org/

Installation
------------

::

pip install git+https://github.com/readthedocs/readthedocs-sphinx-search@master
pip install readthedocs-sphinx-search
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work when there's only an rc release?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah

$ pip install -i https://test.pypi.org/simple/ readthedocs-sphinx-search
Looking in indexes: https://test.pypi.org/simple/
Collecting readthedocs-sphinx-search
  Downloading https://test-files.pythonhosted.org/packages/57/50/849e38d298647d15eeb3e03438a58fc036c0f3b0bec14437803ee1
f81e95/readthedocs_sphinx_search-0.1.0rc2-py3-none-any.whl (25 kB)
Installing collected packages: readthedocs-sphinx-search
Successfully installed readthedocs-sphinx-search-0.1.0rc2



Configuration
Expand All @@ -27,12 +30,6 @@ Add this extension in your ``conf.py`` file as:
]


Documentation
-------------

Check out the full documentation at https://readthedocs-sphinx-search.readthedocs.io/


.. |docs| image:: https://readthedocs.org/projects/readthedocs-sphinx-search/badge/?version=latest
:alt: Documentation Status
:scale: 100%
Expand All @@ -45,3 +42,8 @@ Check out the full documentation at https://readthedocs-sphinx-search.readthedoc
.. |build-status| image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-search.svg?branch=master
:alt: Build Status
:target: https://travis-ci.org/readthedocs/readthedocs-sphinx-search


.. |pypi| image:: https://img.shields.io/pypi/v/readthedocs-sphinx-search.svg
:target: https://pypi.python.org/pypi/readthedocs-sphinx-search
:alt: PyPI Version
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
# The short X.Y version
# The full version, including alpha/beta/rc tags
import sphinx_search
version = release = sphinx_search.version
version = release = sphinx_search.__version__


# -- General configuration ---------------------------------------------------
Expand Down
37 changes: 1 addition & 36 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,4 @@
readthedocs-sphinx-search
=========================

|docs| |license| |build-status|

``readthedocs-sphinx-search`` is a `Sphinx`_ extension which adds a
**full-page search UI** with **search as you type** feature to your documentation.
This extension is compatible with all the documentations hosted on `Read the Docs`_.


In-Doc Search UI
----------------

Using the existing search backend of `Read the Docs`_,
this extension is designed to greatly improve the search experience
of the reader.
To experience it first hand, try searching in this documentation or visit here:
https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing

.. include:: ../README.rst

.. toctree::
:maxdepth: 2
Expand All @@ -30,20 +12,3 @@ https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing
testing
js-api-reference
get-involved


.. _Sphinx: https://www.sphinx-doc.org/
.. _Read the Docs: https://readthedocs.org


.. |docs| image:: https://readthedocs.org/projects/readthedocs-sphinx-search/badge/?version=latest
:alt: Documentation Status
:target: https://readthedocs-sphinx-search.readthedocs.io/en/latest/?badge=latest

.. |license| image:: https://img.shields.io/github/license/readthedocs/readthedocs-sphinx-search.svg
:target: LICENSE
:alt: Repository license

.. |build-status| image:: https://travis-ci.org/readthedocs/readthedocs-sphinx-search.svg?branch=master
:alt: Build Status
:target: https://travis-ci.org/readthedocs/readthedocs-sphinx-search
17 changes: 14 additions & 3 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,37 @@
import setuptools

import sphinx_search


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


setuptools.setup(
name='readthedocs_sphinx_search',
version=sphinx_search.version,
name='readthedocs-sphinx-search',
version=sphinx_search.__version__,
author='Vaibhav Gupta',
author_email='[email protected]',
description='Sphinx extension to enable `search as you type` for docs hosted by Read the Docs.',
description='Sphinx extension to enable search as you type for docs hosted on Read the Docs.',
url='https://github.com/readthedocs/readthedocs-sphinx-search',
license='MIT',
packages=setuptools.find_packages(),
long_description=long_description,
long_description_content_type='text/x-rst',
include_package_data=True,
zip_safe=False,
keywords='sphinx search readthedocs',
python_requires='>=3.6',
project_urls={
'Documentation': 'https://readthedocs-sphinx-search.readthedocs.io/',
'Bug Reports': 'https://github.com/readthedocs/readthedocs-sphinx-search/issues',
'Source': 'https://github.com/readthedocs/readthedocs-sphinx-search',
},
classifiers=[
'Development Status :: 4 - Beta',
'Programming Language :: Python :: 3',
'License :: OSI Approved :: MIT License',
'Operating System :: OS Independent',
'Framework :: Sphinx :: Extension',
],
)
2 changes: 1 addition & 1 deletion sphinx_search/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version = '0.1.dev0'
__version__ = '0.1.0rc1'
2 changes: 0 additions & 2 deletions tests/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# -*- coding: utf-8 -*-

import os


Expand Down
2 changes: 0 additions & 2 deletions tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# -*- coding: utf-8 -*-

"""Pytest fixtures and other things."""

import os
Expand Down
2 changes: 0 additions & 2 deletions tests/test_extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# -*- coding: utf-8 -*-

"""Test working of extension."""

import os
Expand Down
2 changes: 0 additions & 2 deletions tests/test_ui.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# -*- coding: utf-8 -*-

"""UI tests."""

import os
Expand Down
2 changes: 0 additions & 2 deletions tests/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# -*- coding: utf-8 -*-

"""Utils for testing."""

import os
Expand Down