emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: change link format

Browse source
This commit is contained in:
TEC 2022-09-26 02:19:42 +08:00 • committed by Henrik Lissner
parent 58fb83c98e
commit 5ac2a5258b
160 changed files with 1161 additions and 1152 deletions
Download patch file Download diff file Expand all files Collapse all files

62
modules/lang/python/README.org
View file

@ -6,10 +6,10 @@
* Description :unfold:
This module adds [[https://www.python.org/][Python]] support to Doom Emacs.
- Syntax checking ([[doom-package:][flycheck]])
- Syntax checking ([[doom-package:flycheck]])
- Snippets
- Run tests ([[doom-package:][nose]], [[doom-package:][pytest]])
- Auto-format (with ~black~, requires [[doom-module:][:editor format]])
- Run tests ([[doom-package:nose]], [[doom-package:pytest]])
- Auto-format (with ~black~, requires [[doom-module::editor format]])
- LSP integration (=mspyls=, =pyls=, or =pyright=)
** Maintainers
@ -23,7 +23,7 @@ This module adds [[https://www.python.org/][Python]] support to Doom Emacs.
- +cython ::
Enable support for Cython files support.
- +lsp ::
Enable LSP support for ~python-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
Enable LSP support for ~python-mode~. Requires [[doom-module::tools lsp]] and a langserver
(supports mspyls, pyls, and pyright).
- +poetry ::
Enable Python packaging, dependency management, and virtual environment
@ -31,33 +31,33 @@ This module adds [[https://www.python.org/][Python]] support to Doom Emacs.
- +pyenv ::
Enable Python virtual environment support via [[https://github.com/pyenv/pyenv][pyenv]]
- +pyright ::
Use the pyright LSP server instead of mspyls or pyls (requires [[doom-module:][+lsp]]).
Use the pyright LSP server instead of mspyls or pyls (requires [[doom-module:+lsp]]).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
editing. Requires [[doom-module::tools tree-sitter]].
** Packages
- [[doom-package:][anaconda-mode]]
- [[doom-package:][conda]]
- [[doom-package:][nose]]
- [[doom-package:][pipenv]]
- [[doom-package:][pip-requirements]]
- [[doom-package:][poetry]] if [[doom-module:][+poetry]]
- [[doom-package:][pyenv]]
- [[doom-package:][pyimport]]
- [[doom-package:][py-isort]]
- [[doom-package:][python-pytest]]
- if [[doom-module:][+cython]]
- [[doom-package:][cython-mode]]
- [[doom-package:][flycheck-cython]] if [[doom-module:][:checkers syntax]]
- if [[doom-module:][+lsp]]
- if [[doom-module:][+pyright]]
- [[doom-package:][lsp-pyright]]
- [[doom-package:anaconda-mode]]
- [[doom-package:conda]]
- [[doom-package:nose]]
- [[doom-package:pipenv]]
- [[doom-package:pip-requirements]]
- [[doom-package:poetry]] if [[doom-module:+poetry]]
- [[doom-package:pyenv]]
- [[doom-package:pyimport]]
- [[doom-package:py-isort]]
- [[doom-package:python-pytest]]
- if [[doom-module:+cython]]
- [[doom-package:cython-mode]]
- [[doom-package:flycheck-cython]] if [[doom-module::checkers syntax]]
- if [[doom-module:+lsp]]
- if [[doom-module:+pyright]]
- [[doom-package:lsp-pyright]]
- else
- [[doom-package:][lsp-python-ms]]
- [[doom-package:lsp-python-ms]]
** Hacks
- [[doom-package:][anaconda-mode]] is configured to activate when [[doom-package:][lsp-mode]] (or [[doom-package:][eglot]]) don't -- or
- [[doom-package:anaconda-mode]] is configured to activate when [[doom-package:lsp-mode]] (or [[doom-package:eglot]]) don't -- or
fail to.
** TODO Changelog
@ -71,9 +71,9 @@ This module has no hard requirements, but softly depends on:
- For this module's supported test runners:
- ~$ pip install pytest~
- ~$ pip install nose~
- The [[doom-module:][:editor format]] module uses Black for python files: ~$ pip install black~
- [[doom-package:][pyimport]] requires Python's module ~pyflakes~: ~$ pip install pyflakes~
- [[doom-package:][py-isort]] requires [[https://github.com/timothycrosley/isort][isort]] to be installed: ~pip install isort~
- The [[doom-module::editor format]] module uses Black for python files: ~$ pip install black~
- [[doom-package:pyimport]] requires Python's module ~pyflakes~: ~$ pip install pyflakes~
- [[doom-package:py-isort]] requires [[https://github.com/timothycrosley/isort][isort]] to be installed: ~pip install isort~
- Python virtual environments install instructions at:
- [[https://github.com/pyenv/pyenv][pyenv]]
- [[https://conda.io/en/latest/][Conda]]
@ -82,9 +82,9 @@ This module has no hard requirements, but softly depends on:
- ~cython~ requires [[https://cython.org/][Cython]]
** Language Server Protocol Support
For LSP support the [[doom-module:][:tools lsp]] module must be enabled, along with this module's
[[doom-module:][+lsp]] flag. By default, it supports [[doom-package:][mspyls]] and [[doom-package:][pyls]], in that order. With the
[[doom-module:][+pyright]] flag, it will try Pyright first.
For LSP support the [[doom-module::tools lsp]] module must be enabled, along with this module's
[[doom-module:+lsp]] flag. By default, it supports [[doom-package:mspyls]] and [[doom-package:pyls]], in that order. With the
[[doom-module:+pyright]] flag, it will try Pyright first.
Each of these servers must be installed on your system via your OS package
manager or manually:
@ -101,7 +101,7 @@ manager or manually:
This module supports LSP. It requires installation of [[https://pypi.org/project/python-language-server/][Python Language Server]],
[[https://github.com/Microsoft/python-language-server][Microsoft Language Server]], or [[https://github.com/microsoft/pyright][pyright]], see [[Language Server Protocol Support][LSP Support]].
To enable support for auto-formatting with black enable [[doom-module:][:editor format]].
To enable support for auto-formatting with black enable [[doom-module::editor format]].
** Keybindings
| Binding | Description |