Skip to content

Commit a5f3983

Browse files
authored
fixes #671 (#677)
Same issue as in #634, links in md files included in md files from other folders will have wrong relative path in one of the two locations. in this case the root file development_tools.md was working and the debugging.md was broken.
1 parent 92ab96a commit a5f3983

File tree

2 files changed

+54
-33
lines changed

2 files changed

+54
-33
lines changed

src/development_tools.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,52 @@
11
# Development Tools
22

3-
{{#include development_tools/debugging.md}}
3+
## Debugging
4+
5+
| Recipe | Crates | Categories |
6+
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | --------------------------------------- |
7+
| [Log a debug message to the console][ex-log-debug] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
8+
| [Log an error message to the console][ex-log-error] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
9+
| [Log to stdout instead of stderr][ex-log-stdout] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
10+
| [Log messages with a custom logger][ex-log-custom-logger] | [![log-badge]][log] | [![cat-debugging-badge]][cat-debugging] |
11+
| [Log to the Unix syslog][ex-log-syslog] | [![log-badge]][log] [![syslog-badge]][syslog] | [![cat-debugging-badge]][cat-debugging] |
12+
| [Enable log levels per module][ex-log-mod] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
13+
| [Use a custom environment variable to set up logging][ex-log-env-variable] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
14+
| [Include timestamp in log messages][ex-log-timestamp] | [![log-badge]][log] [![env_logger-badge]][env_logger] [![chrono-badge]][chrono] | [![cat-debugging-badge]][cat-debugging] |
15+
| [Log messages to a custom location][ex-log-custom] | [![log-badge]][log] [![log4rs-badge]][log4rs] | [![cat-debugging-badge]][cat-debugging] |
16+
17+
[ex-log-debug]: development_tools/debugging/log.html#log-a-debug-message-to-the-console
18+
[ex-log-error]: development_tools/debugging/log.html#log-an-error-message-to-the-console
19+
[ex-log-stdout]: development_tools/debugging/log.html#log-to-stdout-instead-of-stderr
20+
[ex-log-custom-logger]: development_tools/debugging/log.html#log-messages-with-a-custom-logger
21+
[ex-log-syslog]: development_tools/debugging/log.html#log-to-the-unix-syslog
22+
[ex-log-mod]: development_tools/debugging/config_log.html#enable-log-levels-per-module
23+
[ex-log-env-variable]: development_tools/debugging/config_log.html#use-a-custom-environment-variable-to-set-up-logging
24+
[ex-log-timestamp]: development_tools/debugging/config_log.html#include-timestamp-in-log-messages
25+
[ex-log-custom]: development_tools/debugging/config_log.html#log-messages-to-a-custom-location
426

527
## Versioning
628

7-
| Recipe | Crates | Categories |
8-
|--------|--------|------------|
9-
| [Parse and increment a version string][ex-semver-increment] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
10-
| [Parse a complex version string][ex-semver-complex] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
11-
| [Check if given version is pre-release][ex-semver-prerelease] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
12-
| [Find the latest version satisfying given range][ex-semver-latest] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
13-
| [Check external command version for compatibility][ex-semver-command] | [![semver-badge]][semver] | [![cat-text-processing-badge]][cat-text-processing] [![cat-os-badge]][cat-os]
29+
| Recipe | Crates | Categories |
30+
| --------------------------------------------------------------------- | ------------------------- | ----------------------------------------------------------------------------- |
31+
| [Parse and increment a version string][ex-semver-increment] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
32+
| [Parse a complex version string][ex-semver-complex] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
33+
| [Check if given version is pre-release][ex-semver-prerelease] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
34+
| [Find the latest version satisfying given range][ex-semver-latest] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
35+
| [Check external command version for compatibility][ex-semver-command] | [![semver-badge]][semver] | [![cat-text-processing-badge]][cat-text-processing] [![cat-os-badge]][cat-os] |
1436

1537
## Build Time
1638

17-
| Recipe | Crates | Categories |
18-
|--------|--------|------------|
19-
| [Compile and link statically to a bundled C library][ex-cc-static-bundled] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] |
39+
| Recipe | Crates | Categories |
40+
| -------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------- |
41+
| [Compile and link statically to a bundled C library][ex-cc-static-bundled] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] |
2042
| [Compile and link statically to a bundled C++ library][ex-cc-static-bundled-cpp] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] |
21-
| [Compile a C library while setting custom defines][ex-cc-custom-defines] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] |
43+
| [Compile a C library while setting custom defines][ex-cc-custom-defines] | [![cc-badge]][cc] | [![cat-development-tools-badge]][cat-development-tools] |
2244

2345
[ex-semver-increment]: development_tools/versioning.html#parse-and-increment-a-version-string
2446
[ex-semver-complex]: development_tools/versioning.html#parse-a-complex-version-string
2547
[ex-semver-prerelease]: development_tools/versioning.html#check-if-given-version-is-pre-release
2648
[ex-semver-latest]: development_tools/versioning.html#find-the-latest-version-satisfying-given-range
2749
[ex-semver-command]: development_tools/versioning.html#check-external-command-version-for-compatibility
28-
2950
[ex-cc-static-bundled]: development_tools/build_tools.html#compile-and-link-statically-to-a-bundled-c-library
3051
[ex-cc-static-bundled-cpp]: development_tools/build_tools.html#compile-and-link-statically-to-a-bundled-c-library-1
3152
[ex-cc-custom-defines]: development_tools/build_tools.html#compile-a-c-library-while-setting-custom-defines

src/development_tools/debugging.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
## Debugging
22

3-
| Recipe | Crates | Categories |
4-
|--------|--------|------------|
5-
| [Log a debug message to the console][ex-log-debug] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
6-
| [Log an error message to the console][ex-log-error] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
7-
| [Log to stdout instead of stderr][ex-log-stdout] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
8-
| [Log messages with a custom logger][ex-log-custom-logger] | [![log-badge]][log] | [![cat-debugging-badge]][cat-debugging] |
9-
| [Log to the Unix syslog][ex-log-syslog] | [![log-badge]][log] [![syslog-badge]][syslog] | [![cat-debugging-badge]][cat-debugging] |
10-
| [Enable log levels per module][ex-log-mod] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
11-
| [Use a custom environment variable to set up logging][ex-log-env-variable] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
12-
| [Include timestamp in log messages][ex-log-timestamp] | [![log-badge]][log] [![env_logger-badge]][env_logger] [![chrono-badge]][chrono] | [![cat-debugging-badge]][cat-debugging] |
13-
| [Log messages to a custom location][ex-log-custom] | [![log-badge]][log] [![log4rs-badge]][log4rs] | [![cat-debugging-badge]][cat-debugging] |
3+
| Recipe | Crates | Categories |
4+
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | --------------------------------------- |
5+
| [Log a debug message to the console][ex-log-debug] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
6+
| [Log an error message to the console][ex-log-error] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
7+
| [Log to stdout instead of stderr][ex-log-stdout] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
8+
| [Log messages with a custom logger][ex-log-custom-logger] | [![log-badge]][log] | [![cat-debugging-badge]][cat-debugging] |
9+
| [Log to the Unix syslog][ex-log-syslog] | [![log-badge]][log] [![syslog-badge]][syslog] | [![cat-debugging-badge]][cat-debugging] |
10+
| [Enable log levels per module][ex-log-mod] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
11+
| [Use a custom environment variable to set up logging][ex-log-env-variable] | [![log-badge]][log] [![env_logger-badge]][env_logger] | [![cat-debugging-badge]][cat-debugging] |
12+
| [Include timestamp in log messages][ex-log-timestamp] | [![log-badge]][log] [![env_logger-badge]][env_logger] [![chrono-badge]][chrono] | [![cat-debugging-badge]][cat-debugging] |
13+
| [Log messages to a custom location][ex-log-custom] | [![log-badge]][log] [![log4rs-badge]][log4rs] | [![cat-debugging-badge]][cat-debugging] |
1414

15-
[ex-log-debug]: development_tools/debugging/log.html#log-a-debug-message-to-the-console
16-
[ex-log-error]: development_tools/debugging/log.html#log-an-error-message-to-the-console
17-
[ex-log-stdout]: development_tools/debugging/log.html#log-to-stdout-instead-of-stderr
18-
[ex-log-custom-logger]: development_tools/debugging/log.html#log-messages-with-a-custom-logger
19-
[ex-log-syslog]: development_tools/debugging/log.html#log-to-the-unix-syslog
20-
[ex-log-mod]: development_tools/debugging/config_log.html#enable-log-levels-per-module
21-
[ex-log-env-variable]: development_tools/debugging/config_log.html#use-a-custom-environment-variable-to-set-up-logging
22-
[ex-log-timestamp]: development_tools/debugging/config_log.html#include-timestamp-in-log-messages
23-
[ex-log-custom]: development_tools/debugging/config_log.html#log-messages-to-a-custom-location
15+
[ex-log-debug]: debugging/log.html#log-a-debug-message-to-the-console
16+
[ex-log-error]: debugging/log.html#log-an-error-message-to-the-console
17+
[ex-log-stdout]: debugging/log.html#log-to-stdout-instead-of-stderr
18+
[ex-log-custom-logger]: debugging/log.html#log-messages-with-a-custom-logger
19+
[ex-log-syslog]: debugging/log.html#log-to-the-unix-syslog
20+
[ex-log-mod]: debugging/config_log.html#enable-log-levels-per-module
21+
[ex-log-env-variable]: debugging/config_log.html#use-a-custom-environment-variable-to-set-up-logging
22+
[ex-log-timestamp]: debugging/config_log.html#include-timestamp-in-log-messages
23+
[ex-log-custom]: debugging/config_log.html#log-messages-to-a-custom-location
2424

2525
{{#include ../links.md}}

0 commit comments

Comments
 (0)