Skip to content

Commit

Permalink
Fix broken docs link for logging (#4751)
Browse files Browse the repository at this point in the history
### Before submitting

Please complete the following checklist when submitting a PR:

- [x] All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to
the
      test directory!

- [x] All new functions and code must be clearly commented and
documented.
If you do make documentation changes, make sure that the docs build and
      render correctly by running `make docs`.

- [x] Ensure that the test suite passes, by running `make test`.

- [x] Add a new entry to the `doc/releases/changelog-dev.md` file,
summarizing the
      change, and including a link back to the PR.

- [x] The PennyLane source code conforms to
      [PEP8 standards](https://www.python.org/dev/peps/pep-0008/).
We check all of our code against [Pylint](https://www.pylint.org/).
      To lint modified files, simply `pip install pylint`, and then
      run `pylint pennylane/path/to/file.py`.

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


------------------------------------------------------------------------------------------------------------

**Context:** The logging dev page has an incorrectly formatted Sphinx
reference, causing it to work locally, but fail when deployed. This
updates the link to work on the generated site.

**Description of the Change:**

**Benefits:**

**Possible Drawbacks:**

**Related GitHub Issues:**
  • Loading branch information
mlxd authored Oct 27, 2023
1 parent e7b80bf commit 8c8e3a0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/development/guide/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To enable logging support in your PennyLane work-flow simply run the following l
This will ensure all levels of the execution pipeline log function entries and
outputs. These are logged to handlers pointing to the standard output. Note, since Python's logging framework configuration functions overwrite previous logger configurations, it is expected that :func:`~pennylane.logging.enable_logging()` is called only when not using external logging configurations.

If you are defining custom logging configurations, you can extend the logging configuration options as defined in the section `Customizing the logging configuration <logging-config>`_, or avoid calling :func:`~pennylane.logging.enable_logging()` in favour of tour custom configuration options.
If you are defining custom logging configurations, you can extend the logging configuration options as defined in the section :ref:`Customizing the logging configuration <logging-config>`, or avoid calling :func:`~pennylane.logging.enable_logging()` in favour of tour custom configuration options.

Adding logging supports during development
------------------------------------------
Expand Down

0 comments on commit 8c8e3a0

Please sign in to comment.