From 9a92ff1db67ffbf625ef2a3e5f46c87eb2ee5743 Mon Sep 17 00:00:00 2001 From: Kathy Pippert Date: Thu, 20 Jul 2023 17:04:31 -0400 Subject: [PATCH 01/24] Edits to RST files --- README.rst | 96 +++++++++---------- doc/source/contributing.rst | 46 ++++----- doc/source/examples.rst | 41 ++++---- doc/source/getting-started/index.rst | 33 ++++--- .../installing-pymeilisearch.rst | 32 ++++--- .../getting-started/meilisearch-images.rst | 68 +++++++------ doc/source/index.rst | 43 ++++----- doc/source/user-guide/cli-usage.rst | 89 ++++++++++------- doc/source/user-guide/index.rst | 23 +++-- doc/source/user-guide/web-component.rst | 25 ++--- 10 files changed, 263 insertions(+), 233 deletions(-) diff --git a/README.rst b/README.rst index d719afdf..bd807912 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -pymeilisearch +PyMeilisearch ############# **An enhanced Python API to Meilisearch** @@ -33,95 +33,93 @@ pymeilisearch About ===== -The ``pymeilisearch`` library is a Python command-line interface (CLI) that +PyMeilisearch is a Python command-line interface (CLI) that simplifies integration with `Meilisearch `_, enabling developers to enhance their applications with powerful search functionality by indexing desired data. -Main features of ``pymeilisearch`` are: +PyMeilisearch provdies these key features: -#. **Easy integration** with continuous integration workflows. +- **Easy integration** with continuous integration workflows. -#. **High-level functionality** for indexing data, performing searches, and managing documents. +- **High-level functionality** for indexing data, performing searches, and managing documents. -#. **Powerful capabilities** by enabling filtering options, and indexing - configurations for tailored search experience. +- **Powerful capabilities** for enabling filtering options and indexing + configurations for tailored search experiences. Installation ============ -Installing ``pymeilisearch`` is as easy as running: +Installing the ``pymeilisearch`` package is as easy as running this command: .. code-block:: console python -m pip install pymeilisearch -For other installation methods, please refer to the `official installation guidelines`_. - -.. _official installation guidelines: https://pymeilisearch.docs.ansys.com/version/stable/getting-started/installing-pymeilisearch.html +For other installation methods, refer to `PyMeilisearch installation +`_ +in the PyMeilisearch documentation. Documentation ============= -The `official documentation`_ of ``pymeilisearch`` contains the following chapters: +The `PyMeilisearch documentation`_ contains these sections: -- `Getting started`_. This section provides a brief overview and instructions on - how to get started with the project. It typically includes information on how - to install the project, set up any necessary dependencies, and run a basic - example or test to ensure everything is functioning correctly. +- `Getting started`_: Describes how to install PyMeilisearch + and build your own Docker image for testing PyMeilisearch locally. -- `User guide`_. The user guide section offers detailed documentation and - instructions on how to use the project. It provides comprehensive explanations - of the project's features, functionalities, and configuration options. The - user guide aims to help users understand the project's concepts, best - practices, and recommended workflows. +- `User guide`_: Describes how to use the PyMeilisearch CLI and + integrate PyMeilisearch in a website. -- `API reference`_. The API reference section provides detailed documentation - for the project's application programming interface (API). It includes - information about classes, functions, methods, and their parameters, return - values, and usage examples. This reference helps developers understand the - available API endpoints, their functionalities, and how to interact with them +- `API reference`_: Describes the PyMeilisearch API. For each + subpackage and submodule, it provides information about classes, functions, + methods, parameters, and return values. This reference helps you understand the + available API endpoints, their capabilities, and how to interact with them programmatically. -- `Examples`_. The examples section showcases practical code examples that - demonstrate how to use the project in real-world scenarios. It provides sample - code snippets or complete scripts that illustrate different use cases or - demonstrate specific features of the project. Examples serve as practical - references for developers, helping them understand how to apply the project to - their own applications. +- `Examples`_: Provides code examples that show how to use PyMeilisearch + in real-world scenarios. Sample code snippets and complete scripts + demonstrate different use cases or specific features to help you + understand how to use PyMeilisearch in your own projects. -.. _official documentation: https://pymeilisearch.docs.ansys.com +.. _PyMeilisearch Installation documentation: https://pymeilisearch.docs.ansys.com/version/stable/getting-started/installing-pymeilisearch.html +.. _PyMeilisearch documentation: https://pymeilisearch.docs.ansys.com .. _getting started: https://pymeilisearch.docs.ansys.com/version/stable/getting-started/index.html .. _user guide: https://pymeilisearch.docs.ansys.com/version/stable/user-guide/index.html .. _api reference: https://pymeilisearch.docs.ansys.com/version/stable/autoapi/index.html .. _examples: https://pymeilisearch.docs.ansys.com/version/stable/examples/index.html +.. _PyMeilisearch Issues: https://github.com/ansys/pymeilisearch/issues +.. _PyMeilisearch repository: https://github.com/ansys/pymeilisearch + +Issues +====== -Troubleshooting -=============== +On the `PyMeilisearch Issues`_ page, you can create issues to submit questions, +report bugs, and request new features. -For troubleshooting or reporting issues, please open an issue in the project -repository. +Here is the process for creating an issue: -Please follow these steps to report an issue: +#. Go to the `PyMeilisearch repsitory`_. +#. Click the **Issues** tab to view the **Issues** page. +#. On the **Issues** page, click **New Issue**. +#. In the window that opens, provide a clear and detailed description of the issue + that you are facing. Include any relevant error messages, code snippets, and + screenshots. -- Go to the project repository. -- Click on the ``Issues`` tab. -- Click on the ``New Issue`` button. -- Provide a clear and detailed description of the issue you are facing. -- Include any relevant error messages, code snippets, or screenshots. +To reach the project support team, email `pyansys.core@ansys.com `_. -Additionally, you can refer to the `project documentation`_ for additional -resources and troubleshooting guides. -.. _project documentation: https://pymeilisearch.docs.ansys.com +License and acknowledgements +============================ +PyMeilisearch is licensed under the MIT license. -License -======= +PyMeilisearch is a Python CLI that simplifies integration with +`Meilisearch `_. -You can find the full text of the license in the `LICENSE` file. +You can see the full text of the license in the `LICENSE` file. .. _license: https://github.com/ansys/pymeilisearch/blob/main/LICENSE diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 788389ae..cc7803af 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -6,16 +6,16 @@ Contributing Overall guidance on contributing to a PyAnsys library appears in the `Contributing `_ topic in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar -with it and all `Coding style `_ before attempting to -contribute to pymeilisearch. +with this guide before attempting to contribute to PyMeilisearch. -The following contribution information is specific to pymeilisearch. +The following contribution information is specific to PyMeilisearch. -Cloning the pymeilisearch repository ------------------------------------- +Clone the repository +-------------------- -Run this code to clone and install the latest version of pymeilisearch in development mode: +To clone and install the latest version of PyMmeilisearch in development mode, +run this code: .. code:: console @@ -25,25 +25,25 @@ Run this code to clone and install the latest version of pymeilisearch in develo pip install -e . -Posting issues --------------- +Post issues +----------- -Use the `pymeilisearch Issues `_ +Use the `PyMeilisearch Issues `_ page to submit questions, report bugs, and request new features. When possible, use these issue templates: * Bug report template * Feature request template -If your issue does not fit into one of these categories, create your own issue. +If your issue does not fit into one of these template categories, create your own issue. -To reach the project support team, email `Pyansys core `_. +To reach the project support team, email `pyansys.core@ansys.com `_. -Viewing pymeilisearch documentation ------------------------------------ +View documentation +------------------ -Documentation for the latest stable release of pymeilisearch is hosted at -`pymeilisearch Documentation `_. +Documentation for the latest stable release of PyMeilisearch is hosted at +`PyMeilisearch documentation `_. In the upper right corner of the documentation's title bar, there is an option for switching from viewing the documentation for the latest stable release @@ -51,23 +51,23 @@ to viewing the documentation for the development version or previously released versions. -Code style ----------- +Adhere to code style +-------------------- -pymeilisearch follows PEP8 standard as outlined in the `PyAnsys Development Guide -`_ and implements style checking using +PyMeilisearch follows the PEP8 standard as outlined in the `PyAnsys Developer's Guide +`_ and implements style checking using `pre-commit `_. -To ensure your code meets minimum code styling standards, run:: +To ensure your code meets minimum code styling standards, run these commands:: pip install pre-commit pre-commit run --all-files -You can also install this as a pre-commit hook by running:: +You can also install this as a pre-commit hook by running this command:: pre-commit install -This way, it's not possible for you to push code that fails the style checks. For example:: +This way, it's not possible for you to push code that fails the style checks:: $ pre-commit install $ git commit -am "FEAT: added the new feature" @@ -83,7 +83,7 @@ This way, it's not possible for you to push code that fails the style checks. Fo .. _precommit: https://pre-commit.com/ .. _dev_guide_contributing: https://dev.docs.pyansys.com/how-to/contributing.html -.. _PyAnsys Developer's guide: https://dev.docs.pyansys.com/ +.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/ .. _dev_guide_coding_style: https://dev.docs.pyansys.com/coding-style/index.html .. _pymeilisearch_docs: https://pymeilisearch.docs.ansys.com/version/stable/ .. _pymeilisearch_issues: https://github.com/ansys/pymeilisearch/issues diff --git a/doc/source/examples.rst b/doc/source/examples.rst index e2e7f0bc..8891597a 100644 --- a/doc/source/examples.rst +++ b/doc/source/examples.rst @@ -1,49 +1,44 @@ Examples ======== +This section provides some usage examples for PyMeilisearch. +Create an index from online files +--------------------------------- - -Using pymeilisearch CLI utility -------------------------------- - -Creating an index from an online page -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To create an index from an online page, you can use the `pymeilisearch` CLI utility as follows: +This command creates an index from online files: .. code-block:: shell pymeilisearch upload --template