Skip to content

Commit f183dde

Browse files
Copilotubmarco
andauthored
πŸ› Fix linkcheck CI job warnings (useblocks#1667)
`tox -e docs-linkcheck` fails due to 4 warnings promoted to errors by `-W` flag. - **`docs/directives/needbar.rst`**: Fix 3 duplicate target name "transpose" errors β€” the named hyperlink `` `transpose <...>`_ `` conflicted with the section heading target. Changed to anonymous reference (`` `transpose <...>`__ ``). - **`docs/utils.rst`**: Remove duplicate toctree entry for `performance/debug`, already included via `performance/index`. - **`docs/conf.py`**: Add `("py:class", "dict[str")` to `nitpick_ignore` for a malformed autodoc-generated type reference. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ubmarco <839934+ubmarco@users.noreply.github.com>
1 parent 466ad2e commit f183dde

3 files changed

Lines changed: 2 additions & 2 deletions

File tree

β€Ždocs/conf.pyβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
("py:class", "sphinx_needs.config.NeedsSphinxConfig"),
5353
("py:class", "AllowedTypes"),
5454
("py:class", "FieldSchemaTypes"),
55+
("py:class", "dict[str"), # malformed type ref generated by autodoc
5556
]
5657

5758
rst_epilog = """

β€Ždocs/directives/needbar.rstβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ The ``:horizontal:`` flag does not support any values and it's useful with the `
288288
transpose
289289
~~~~~~~~~
290290

291-
You can `transpose <https://en.wikipedia.org/wiki/Transpose>`_ the data in the content by setting the ``:transpose:`` flag.
291+
You can `transpose <https://en.wikipedia.org/wiki/Transpose>`__ the data in the content by setting the ``:transpose:`` flag.
292292
The idea is, you can try to see the data from different point of view, without refactoring.
293293

294294
The ``:transpose:`` flag does not support any values and it's useful with big content tables.

β€Ždocs/utils.rstβ€Ž

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@ Utils
77
:maxdepth: 2
88

99
performance/index
10-
performance/debug

0 commit comments

Comments
Β (0)