Sphinx Language Support

This project provides tools to improve the authoring experience of working with Sphinx documentation projects.

Principally, it provides:

• a sphinx extension to generate an database of key information from a Sphinx project,

• a language server to provide code intelligence for Sphinx projects, and

• a VS Code extension to run the language server.

See Extension features for more information on the features provided by the VS Code extension, which include:

• multi-project support,

• running Sphinx builds,

• opening HTML previews,

• outlines, auto-completions and hover information, …

Quick Start

1. See the Sphinx guide for setting up a Sphinx project.

2. Within your sphinx Python environment, install the sphinx_indexer package, and add the extension to your conf.py file:

   extensions = [..., "sphinx_indexer"]
   

3. Run the the sphinx build.

4. Either add a sphinx.toml file in the project root or add to an existing pyproject.toml file the following content:

   sphinx.toml

   srcdir = "."       # or the relative path to your source folder
   
   [builds.default]
   outdir = "_build"  # or the relative path to your build folder
   command = "sphinx-build {{srcdir}} {{outdir}}"
   

   pyproject.toml

   [tool.sphinx]
   srcdir = "."       # or the relative path to your source folder
   
   [tool.sphinx.builds.default]
   outdir = "_build"  # or the relative path to your build folder
   command = "sphinx-build {{srcdir}} {{outdir}}"
   

5. Open your project in VS Code and install the Sphinx Language Support extension.

6. Try out the features defined in the Extension features.

See also

• The configuration guide

• How it works for an overview of the system architecture.

• Troubleshooting for troubleshooting and debugging tips.

• Development for how to develop the tools.

Site Map

• Quick Start

User Guides

• Configuration
  • File discovery
  • Top-level configuration
  • Build configuration
• How it works
• Troubleshooting

Components

• VS Code Extension
• sphinx_lsp
• sphinx_indexer
• sphinx_db

Development

• Development
  • Repository structure
  • Formatting and linting
  • Managing the Python code
  • Managing the VS Code Extension
  • Packaging the VS Code Extension
  • Design notes

Indices and tables

• Index

• Module Index

• Search Page

TODOs

Todo

Add description

(The original entry is located in /Users/chrisjsewell/GitHub/sphinx-lsp/docs/source/components/sphinx_db.rst, line 6.)

Todo

Add description

(The original entry is located in /Users/chrisjsewell/GitHub/sphinx-lsp/docs/source/components/sphinx_lsp.rst, line 6.)

Todo

Add troubleshooting guide

(The original entry is located in /Users/chrisjsewell/GitHub/sphinx-lsp/docs/source/usage/troubleshooting.rst, line 6.)