sphinx-codeautolink
sphinx-codeautolink copied to clipboard
felix-hilden
Automatic links from code examples to reference documentation
We don't link assignment targets, arguments and (I think) single names: ```python import lib target = lib.Thing() target def foo(arg: lib.Thing): pass ``` We could reconsider this, at least for...
From #103: it could be annoying to deal with e.g. missing inventory warnings when a package and its documentation is out of your reach. But having warnings is still beneficial....
From #97: I'm still unsure if we should do this, but let's separate the issues. We could issue warnings on unassigned names, possibly from missing import statements. What I'm worried...
Sometimes class instances could be encountered. So how do they behave and what should we do with them?
From #5: we have the machinery in place to track subscripts and unpacking assignments by analysing type hints that are nested tuples or lists of simple types: ```python class A:...
When implementing match support in #110 I ran into very hard to navigate issues, which led me to introduce two X-fails to the test suite. The problem is: Match statements...
Hi @felix-hilden, This is a really neat library, and I have many repositories that could benefit enormously from this functionality. I'm wondering if you would be interested in making this...
### Issue When adding `:lineno:` to code-blocks and literalinclude's this breaks the linking and all the links are absent with the compiler giving `Could not resolve` and `Could not match...
Wild idea... could we use mypy for resolving types in code examples? It is static analysis after all, and *very* comprehensive. I wonder if there is mypy internal we could...
### Issue When building the Bokeh docs, things expode: ``` Traceback (most recent call last): File "/Users/bryan/anaconda/envs/dev-311/lib/python3.11/site-packages/sphinx/events.py", line 94, in emit results.append(listener.handler(self.app, *args)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/Users/bryan/anaconda/envs/dev-311/lib/python3.11/site-packages/sphinx_codeautolink/extension/__init__.py", line 42, in wrapper...
Metadata
Owner
Metadata
Automatic links from code examples to reference documentation