Issue building documentation with mkdocs

[rbarzic]

Not sure if I'm doing something wrong but I got the following message when running mkdocs build:

roba@onio-ws08  15:06:30  mkdocs build                                                                   
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /home/roba/tmp/textual/site
ERROR    -  mkdocstrings.extension: 'type' object is not subscriptable
            Traceback (most recent call last):
              File "/home/roba/.virtualenvs/textual-test/lib/python3.8/site-packages/pytkdocs/cli.py", line 205, in main
                output = json.dumps(process_json(line))
              File "/home/roba/.virtualenvs/textual-test/lib/python3.8/site-packages/pytkdocs/cli.py", line 114, in process_json
                return process_config(json.loads(json_input))
              File "/home/roba/.virtualenvs/textual-test/lib/python3.8/site-packages/pytkdocs/cli.py", line 91, in process_config
                obj = loader.get_object_documentation(path, members)
              File "/home/roba/.virtualenvs/textual-test/lib/python3.8/site-packages/pytkdocs/loader.py", line 358, in
            get_object_documentation
                root_object = self.get_class_documentation(leaf, members)
              File "/home/roba/.virtualenvs/textual-test/lib/python3.8/site-packages/pytkdocs/loader.py", line 455, in
            get_class_documentation
                merge(attributes_data, get_class_attributes(parent_class))
              File "/home/roba/.virtualenvs/textual-test/lib/python3.8/site-packages/pytkdocs/parsers/attributes.py", line 115, in
            get_class_attributes
                type_hints = get_type_hints(cls)
              File "/usr/lib/python3.8/typing.py", line 1232, in get_type_hints
                value = _eval_type(value, base_globals, localns)
              File "/usr/lib/python3.8/typing.py", line 270, in _eval_type
                return t._evaluate(globalns, localns)
              File "/usr/lib/python3.8/typing.py", line 518, in _evaluate
                eval(self.__forward_code__, globalns, localns),
              File "<string>", line 1, in <module>
            TypeError: 'type' object is not subscriptable
ERROR    -  Error reading page 'reference/app.md':
ERROR    -  Could not collect 'textual.app.App'

Aborted with a BuildError!

I've done the following

git clone https://github.com/willmcgugan/textual.git
cd textual
mkvirtualenv -p python3 textual-test
pip install poetry
poetry install
mkdocs build

[willmcgugan]

Docs are work in progress. Nothing to build as yet.

[pawamoy]

Hopefully the next Python handler will work better 🙂
In the meantime don't hesitate to open issues on our side: https://github.com/mkdocstrings/pytkdocs/issues and https://github.com/mkdocstrings/mkdocstrings/issues

[pawamoy]

@willmcgugan mkdocstrings now offers a new, experimental handler that does not execute the code (at least not at first), but rather just reads, parses and visits the AST from sources 🙂 It will typically fix this kind of issues, if you want to give it a try.

By the way, TypeError: 'type' object is not subscriptable tells me you're using future annotations (list[str]), and pytkdocs (underlying data extractor of the legacy handler) didn't support it very well.

[willmcgugan]

Awesome. Pulling docs from the AST is clever!

[pawamoy]

Note that it does not work well for dynamic objects though 😅 (inference is hard!). But for regular class, functions, attributes definitions, it's more than enough.

[tusharsadhwani]

inference is hard

It sure is in dynamic languages! I've been following mkdocstrings for a while, and I really like the project. Thanks for the work!