Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

1.0 when? #901

Open
5 of 14 tasks
alcarney opened this issue Sep 23, 2024 · 1 comment
Open
5 of 14 tasks

1.0 when? #901

alcarney opened this issue Sep 23, 2024 · 1 comment
Milestone

Comments

@alcarney
Copy link
Member

At this point the 1.0 version of the language server has been in development for over a year, so you might at this point be thinking... when will it be ready?!

I would argue that it's ready today if

  • You need modern Python support (v3.12+)
  • You need modern Sphinx support (v7+)
  • You need features not available in the stable version
    • MyST support
    • Workspace symbols
    • Synchronised preview scrolling
    • Multi-project / multi-root support

Once you get it running, it is already stable and the features that have been implemented are arguably better than what you will find in the release version. However, compared to the 0.16.x version there are some features missing.

  • Diagnostics
  • Document Symbols
  • Completion suggestions for
    • Role names
    • Targets for :ref:, :doc: etc.
    • Filepaths for :download: etc.
    • Directive names
    • Directive options
    • Filepaths for .. image:: etc.
  • Goto
    • Definition of targets for :ref:/:doc:
    • Implementation of roles/directives
  • Documentation Hovers
  • Document Links

So, 1.0 will be released once the remaining features have been ported across.

@alcarney alcarney added this to the 1.0 milestone Sep 23, 2024
@alcarney alcarney pinned this issue Sep 23, 2024
@hwayne
Copy link

hwayne commented Sep 24, 2024

Exciting!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants