Metadata-Version: 2.4
Name: sphinx_pushfeedback
Version: 0.1.7
Summary: Feedback widget for Sphinx.
Home-page: https://github.com/techdocsstudio/sphinx-pushfeedback
Author: TechDocs Studio
Author-email: info@techdocs.studio
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Classifier: Framework :: Sphinx :: Extension
License-File: LICENSE.md
Requires-Dist: sphinx >= 3
Requires-Dist: furo ; extra == "doc"
Requires-Dist: pre-commit ; extra == "test"
Requires-Dist: pytest ; extra == "test"
Provides-Extra: doc
Provides-Extra: test

sphinx-pushfeedback
===================

Feedback widget for Sphinx documentation sites.

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

#. Create a `PushFeedback account <http://pushfeedback.com/>`_.

#. Install ``sphinx-pushfeedback`` using PIP.

   .. code-block:: bash

      pip install sphinx-pushfeedback

#. Add the extension to your Sphinx project ``conf.py`` file.

   .. code-block:: python

      extensions = ['sphinx_pushfeedback']

#. Configure your project ID in the ``conf.py`` file:

   .. code-block:: python

     pushfeedback_project = '<YOUR_PROJECT_ID>'

   Replace ``<YOUR_PROJECT_ID>`` with your project's ID from the `PushFeedback dashboard <https://docs.pushfeedback.com/#2-create-a-project>`_.

#. Build the documentation:

   .. code-block:: bash

      make html

   Once built, open your documentation in a web browser. Verify that the feedback button appears and works correctly on your site.

For advanced configuration options, see `Sphinx PushFeedback documentation <https://docs.pushfeedback.com/installation/sphinx>`_.

License
-------

Copyright (c) 2023 PushFeedback.com
Licensed under the `MIT License <https://github.com/dgarcia360/sphinx-pushfeedback/blob/main/LICENSE.md>`_.

