mirror of
https://github.com/haskell/haskell-language-server.git
synced 2024-09-11 16:56:14 +03:00
f0bbc390b9
* Rework features documentation This does a few things: - Adds a clear listing of which LSP methods we support, and which we don't (requested a couple of times recently). - Lists every code action and code lens, which plugin provies them, their status, and code action kind where applicable (apart from Wingman because there are lots and I couldn't figure it all out). Possibly some of this information belongs elsewhere, e.g. perhaps instead of listing which versions don't have full support on this page, we should instead add a page to the GHC support page that lists which plugins work on which versions. Not sure. * Add a couple of known limitations * Move plugin GHC version support to other page * Purge useless status column * Update docs/features.md Add link to qualify imported names readme * Update docs/features.md * Update docs/features.md * Update docs/features.md * Update docs/features.md * Update docs/features.md i don't know how to use github * Clarify text * Mention limitations of apply-refact Co-authored-by: J. S <document_done@hotmail.com> Co-authored-by: Pepe Iborra <pepeiborra@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
95 lines
3.1 KiB
Python
95 lines
3.1 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
import re
|
|
import sys
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'haskell-language-server'
|
|
|
|
# We want to take some of the metadata from the Cabal file, especially the version.
|
|
# (otherwise it's very easy to forget to update it!)
|
|
release = None
|
|
copyright = None
|
|
author = None
|
|
versionPattern = re.compile("^version:\s*([\d.]+)")
|
|
copyrightPattern = re.compile("^copyright:\s*(.+)")
|
|
authorPattern = re.compile("^author:\s*(.+)")
|
|
for i, line in enumerate(open('../haskell-language-server.cabal')):
|
|
versionMatch = re.search(versionPattern, line)
|
|
if versionMatch:
|
|
release = versionMatch.group(1)
|
|
copyrightMatch = re.search(copyrightPattern, line)
|
|
if copyrightMatch:
|
|
copyright = copyrightMatch.group(1)
|
|
authorMatch = re.search(authorPattern, line)
|
|
if authorMatch:
|
|
author = authorMatch.group(1)
|
|
|
|
if not release:
|
|
print("Couldn't find version")
|
|
sys.exit()
|
|
if not copyright:
|
|
print("Couldn't find copyright")
|
|
sys.exit()
|
|
if not author:
|
|
print("Couldn't find author")
|
|
sys.exit()
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'myst_parser',
|
|
'sphinx_rtd_theme',
|
|
'sphinx.ext.autosectionlabel'
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_logo = "logos/logo-64.png"
|
|
html_favicon = "logos/logo.svg"
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['_static']
|
|
|
|
# Enable linking to an anchor of a relative page
|
|
# See https://github.com/executablebooks/MyST-Parser/issues/443
|
|
myst_heading_anchors = 3
|
|
|
|
# -- Custom Document processing ----------------------------------------------
|
|
|
|
def setup(app):
|
|
app.add_css_file("theme_overrides.css")
|