Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Documentation site doesn't display text #76

Closed
predragnikolic opened this issue Aug 25, 2021 · 1 comment · Fixed by #77
Closed

Documentation site doesn't display text #76

predragnikolic opened this issue Aug 25, 2021 · 1 comment · Fixed by #77

Comments

@predragnikolic
Copy link
Member

I believe that the methods should be automatically documented, but right now nothing is displayed:

https://sublimelsp.github.io/lsp_utils/client_handlers.html
@rchl
Copy link
Member

rchl commented Aug 25, 2021

Probably due to this error:

  File "LSP/plugin/core/views.py", line 31, in <module>
    _baseflags = sublime.DRAW_NO_FILL | sublime.DRAW_NO_OUTLINE | sublime.DRAW_EMPTY_AS_OVERWRITE
TypeError: unsupported operand type(s) for |: 'DRAW_NO_FILL' and 'DRAW_NO_OUTLINE'

The problem is that sphinx can't use stub files apparently (ref). It can only auto-stub modules but that fails on that line...

rchl added a commit that referenced this issue Aug 25, 2021
@rchl
fix docs generation
0f0a87b 
Fixes error:

```
  File "/LSP/plugin/core/views.py", line 31, in <module>
    _baseflags = sublime.DRAW_NO_FILL | sublime.DRAW_NO_OUTLINE | sublime.DRAW_EMPTY_AS_OVERWRITE
TypeError: unsupported operand type(s) for |: 'DRAW_NO_FILL' and 'DRAW_NO_OUTLINE'
```

on `make build`.

Sphinx is not able to properly handle types for auto-stubbed sublime
module and does not support stub files so hack around it by changing
the failing constants to 0.

Fixes #76
@rchl rchl mentioned this issue Aug 25, 2021
Merged
@rchl rchl closed this as completed in #77 Aug 25, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix docs generation sublimelsp/lsp_utils
2 participants
@rchl @predragnikolic