Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links in docs #240

Merged
merged 1 commit into from
Feb 18, 2025
Merged
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The rest of this document describes the technical details of getting set up to d
Setting up your development environment
---------------------------------------

We leverage `poetry <https://python-poetry.org/>` for packaging and dependency management.
We leverage `poetry <https://python-poetry.org/>`_ for packaging and dependency management.
After installing poetry, run the following commands to clone the repository, create a poetry managed virtual environment for development, and install dependencies.

.. code:: bash
Expand All @@ -37,7 +37,7 @@ and build the documentation by changing to the ``docs/source`` directory where y

The built documentation will then live in ``ucc/docs/source/_build/html``.

We also use `pre-commit <https://pre-commit.com/>` to run code formatting and linting checks before each commit.
We also use `pre-commit <https://pre-commit.com/>`_ to run code formatting and linting checks before each commit.
To enable the pre-commit hooks, run

.. code:: bash
Expand Down Expand Up @@ -80,7 +80,7 @@ When proposing a new transpiler pass, please include a detailed report containin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Once the prototype is validated, implement the new pass in the codebase.
Documentation to guide you through this process is available in the `User Guide <user_guide>`_.
Documentation to guide you through this process is available in the :doc:`user guide <user_guide>`.
For more detailed information and examples, refer to the `Qiskit documentation <https://docs.quantum.ibm.com/guides/custom-transpiler-pass>`_.

4. Clear Acceptance Criteria for Incorporation into default transpiler
Expand Down