Skip to content

Commit 89de1a8

Browse files
committed
Minor cleanup and link fixes
1 parent 811fa44 commit 89de1a8

8 files changed

Lines changed: 12 additions & 16 deletions

File tree

docs/explanation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This page explains the underlying concepts behind Python logging and how daqpytools builds on them. Reading this will help you understand *why* the how-to guides are structured the way they are.
44

5-
For hands-on instructions, see the how-to guides. For the API reference, see the [reference](https://dune-daq.github.io/daqpytools/APIref).
5+
For hands-on instructions, see the how-to guides. For the API reference, see the [reference](../../APIref).
66

77
---
88

@@ -128,6 +128,6 @@ For a hands on explanation of these, please read the [how-to guide on how to use
128128

129129
## Further reading
130130

131-
- For how this routing model is implemented under the hood, see the [developer explanation](https://dune-daq.github.io/daqpytools/dev).
132-
- The architecture reference includes diagrams which explain exactly how the routing works. See [here](https://dune-daq.github.io/daqpytools/dev/reference/architecture/).
131+
- For how this routing model is implemented under the hood, see the [developer explanation](../../dev/).
132+
- The architecture reference includes diagrams which explain exactly how the routing works. See [here](../../dev/reference/architecture/).
133133
- For how to configure ERS and advanced routing in practice, see [Configuring ERS](./how-to/configure-ers.md) and [Routing messages to specific handlers](./how-to/route-messages.md).

docs/how-to/add-handlers-at-runtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ log.info("Now routes to rich + stdout by default")
3232

3333
## Suppress by default with `fallback_handler={HandlerType.Unknown}`
3434

35-
This feature takes heavy advantage of the `extra` feature of Python logging. Please read the documentation on how `extra` is used, [found here](https://dune-daq.github.io/daqpytools/dev/explanation/).
35+
This feature takes heavy advantage of the `extra` feature of Python logging. Please read the documentation on how `extra` is used, [found here](../../../dev/explanation/).
3636

3737
You can make newly-added handlers opt-in only by setting fallback handlers to `HandlerType.Unknown`. This means records without explicit `extra["handlers"]` will not be emitted by those handlers.
3838

docs/how-to/configure-ers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This page covers how to attach and use ERS (error reporting system) handlers on a logger.
44

5-
For background on ERS streams and routing, see [Concepts](../explanation.md). For the `LogHandlerConf` routing API, see [Routing messages to specific handlers](./route-messages.md). For the definition of the handler itself as well as how it can be used, see [How to use handlers and filters](https://dune-daq.github.io/daqpytools/dev/explanation/).
5+
For background on ERS streams and routing, see [Concepts](../explanation.md). For the `LogHandlerConf` routing API, see [Routing messages to specific handlers](./route-messages.md). For the definition of the handler itself as well as how it can be used, see [How to use handlers and filters](../../../dev/explanation/).
66

77
---
88

99
## Configuring ERS handlers onto a new logger (by construction)
1010

11-
Use the `ers_kafka_session` variable to put in the relevant session name in `get_daq_logger`. There are several attributes that you can use to customise the ERS handler as well, such as changing the ERS application name as displayed on the ERS dashboards, exampled below. Please see the [API reference](https://dune-daq.github.io/daqpytools/APIref/handlers/protobufstream/) for full details on what can be passed in.
11+
Use the `ers_kafka_session` variable to put in the relevant session name in `get_daq_logger`. There are several attributes that you can use to customise the ERS handler as well, such as changing the ERS application name as displayed on the ERS dashboards, exampled below. Please see the [API reference](../../../APIref/handlers/protobufstream/) for full details on what can be passed in.
1212

1313
```python
1414
from daqpytools.logging import get_daq_logger,

docs/how-to/use-handlers.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,7 @@ This page walks through each available handler and filter in daqpytools with sho
44

55
Remember that by default, any messages received by the logger will be transmitted to _all_ available handlers that are attached to the logger.
66

7-
**For now, please view both `get_daq_logger` and the relevant builders in `handlers.py` and `filters.py` to see what options exist on how to initialise them.**
8-
9-
**In the future, this will be automatically generated from the docstrings.**
10-
11-
For the full API reference (kwargs, types, defaults), see the [auto-generated reference](https://dune-daq.github.io/daqpytools/APIref).
7+
For the full API reference (kwargs, types, defaults), see the [auto-generated reference](../../../APIref/).
128

139
---
1410

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ This documentation is split into two sections depending on your role:
2222
| [How to upgrade an existing package](./how-to/upgrade-package.md) | Migration checklist for adopting daqpytools logging in existing codebases |
2323
| [Best practices](./how-to/best-practices.md) | Recommended patterns for structuring logging in your application |
2424
| [Troubleshooting](./reference/troubleshooting.md) | Common symptoms, causes, and fixes |
25-
| [API reference](https://dune-daq.github.io/daqpytools/APIref) | Auto-generated kwargs, types, and defaults for all public APIs (redirects to MKDocs website) |
25+
| [API reference](../APIref/) | Auto-generated kwargs, types, and defaults for all public APIs (redirects to MKDocs website) |
2626

docs/reference/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This page lists common symptoms, their likely causes, and fixes.
44

5-
For a systematic debugging workflow when extending the system, see the [developer debugging checklist](https://dune-daq.github.io/daqpytools/dev/how-to/debug-routing/).
5+
For a systematic debugging workflow when extending the system, see the [developer debugging checklist](../../../dev/how-to/debug-routing/).
66
---
77

88
| Symptom | Likely cause | What to check | Fix |

docs/tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ test_logger = get_daq_logger(
2626
)
2727
```
2828

29-
Please see the API reference of `get_daq_logger` [here](https://dune-daq.github.io/daqpytools/APIref/get_daq_logger/), or alternatively the code itself [here](https://github.com/DUNE-DAQ/daqpytools/blob/develop/src/daqpytools/logging/logger.py), to see what options exist in initialising `get_daq_logger`.
29+
Please see the API reference of `get_daq_logger` [here](../../APIref/get_daq_logger/), or alternatively the code itself [here](https://github.com/DUNE-DAQ/daqpytools/blob/develop/src/daqpytools/logging/logger.py), to see what options exist in initialising `get_daq_logger`.
3030

3131
This gives you a named logger with a single Rich handler attached, emitting at `INFO` level and above. Loggers in daqpytools are singletons — calling `get_daq_logger` with the same name twice will return the same instance, so it's safe to call this once at module level and reuse it throughout your code.
3232

@@ -61,5 +61,5 @@ The Rich handler supports the full [Rich markup syntax](https://rich.readthedocs
6161
View the help string to learn more, and the script itself in the repository to see how it is implemented.
6262
- To understand *why* logging works the way it does, read the [Concepts & explanation](./explanation.md).
6363
- To learn how to use specific handlers and filters, see the [How-to guides](./how-to/use-handlers.md).
64-
- For a full API reference, see the [API Ref](https://dune-daq.github.io/daqpytools/APIref).
64+
- For a full API reference, see the [API Reference](../../APIref/).
6565
- If you are introducing logging to your Python repo, or upgrading an existing implementation, **please** read the [Logging best practices](./how-to/best-practices.md).

docs_dev/explanation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This page is for developers who want to understand the internals of daqpytools logging — for example, to add a new handler or debug a routing issue.
44

5-
For user-facing concepts (Python logging fundamentals, streams), see the [user explanation](https://dune-daq.github.io/daqpytools/user/explanation/).
5+
For user-facing concepts (Python logging fundamentals, streams), see the [user explanation](../../user/explanation/).
66
For implementation recipes, see the how-to guides.
77

88
---

0 commit comments

Comments
 (0)