diff --git a/docs/getting_started/introduction.rst b/docs/getting_started/introduction.rst index 105c7cc..a2a0eab 100644 --- a/docs/getting_started/introduction.rst +++ b/docs/getting_started/introduction.rst @@ -32,15 +32,15 @@ Installation Once prerequisites have been satisfied, Patcher can be installed via ``pip``: -.. code-block:: console +.. code-block:: shell - python3 -m pip install --upgrade patcherctl + % python3 -m pip install --upgrade patcherctl Optionally, beta releases of Patcher are released to `Test PyPI `_ and can be installed via the following command: -.. code-block:: bash +.. code-block:: shell - python3 -m pip install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple patcherctl=={VERSION} + % python3 -m pip install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple patcherctl=={VERSION} Where ``{VERSION}`` is the beta version you are looking to install, e.g. ``1.3.4b2``. diff --git a/docs/reference/cli.rst b/docs/reference/cli.rst index 2741b1f..54887e9 100644 --- a/docs/reference/cli.rst +++ b/docs/reference/cli.rst @@ -6,7 +6,7 @@ Command Line Interface .. note:: - The CLI entry point collaborates with the :mod:`patcher.client.report_manager` module. Most of the operations are managed by the Report Manager class, where debug logs are also generated, rather than within the CLI entry point. + The CLI entry point collaborates with the :mod:`~patcher.client.report_manager` module. Most of the operations are managed by the Report Manager class, where debug logs are also generated, rather than within the CLI entry point. The main entry point for the Patcher CLI (patcherctl). @@ -20,7 +20,7 @@ Parameters The path to save the report(s). - **pdf** (*bool*): - If passed, Patcher will generate a PDF report along with the Excel spreadsheet using the :mod:`pdf_report` model. + If passed, Patcher will generate a PDF report along with the Excel spreadsheet using the :mod:`~patcher.models.reports.pdf_report` model. - **sort** (*Optional[AnyStr]*): Sort patch reports by a specified column. @@ -47,4 +47,4 @@ Parameters Enable debug logging to see detailed debug messages. Providing this option replaces the animation usually shown to ``stdout``. - **reset** (*bool*): - Resets the ``config.ini`` file used for customizable elements in exported PDF reports, then triggers :func:`patcher.client.setup._setup_ui` method. See :ref:`Customizing Reports ` for more information. + Resets the ``config.ini`` file used for customizable elements in exported PDF reports, then triggers :func:`~patcher.client.setup._setup_ui` method. See :ref:`Customizing Reports ` for more information. diff --git a/docs/reference/utils/wrappers.rst b/docs/reference/utils/wrappers.rst index f338d44..803607a 100644 --- a/docs/reference/utils/wrappers.rst +++ b/docs/reference/utils/wrappers.rst @@ -4,7 +4,7 @@ Wrappers .. note:: - We are planning to refactor the ``check_token`` function into the :mod:`TokenManager` class as it is more suitable for that scope. + We are planning to refactor the ``check_token`` function into the :mod:`~patcher.client.token_manager` class as it is more suitable for that scope. .. automodule:: patcher.utils.wrappers :members: