branch: elpa/flycheck
commit 9d038dc05e4c7b7bd00df65a89f18f372d9c6d8c
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Fix stale content in documentation
- Use HTTPS for MELPA Stable URL and fix code-block language (cl -> elisp)
- Update Python version requirement from 3.4 to 3.9
- Replace virtualenv reference with generic "virtual environment"
---
doc/contributor/contributing.rst | 9 ++++-----
doc/index.rst | 6 +++---
2 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/doc/contributor/contributing.rst b/doc/contributor/contributing.rst
index f99bbb1195..883000fd8b 100644
--- a/doc/contributor/contributing.rst
+++ b/doc/contributor/contributing.rst
@@ -152,15 +152,15 @@ Documentation improvements are very welcome. Flycheck’s
manual is written in
reStructuredText_ and built with Sphinx_. The source of the manual resides in
the ``doc/`` directory.
-You need Python 3.4 or newer to install Sphinx_ for Flycheck’s documentation.
+You need Python 3.9 or newer to install Sphinx_ for Flycheck’s documentation.
On macOS it is recommended that you use Homebrew_ to install the latest Python
version with ``brew install python3``. On Linux you should be able to obtain
-Python 3.4 from the package manager of your distribution.
+Python 3 from the package manager of your distribution.
With Python 3 installed change into the ``doc/`` directory and run ``make
init``
to install Sphinx and related tools required for Flycheck’s documentation. We
-recommend that you use virtualenv_ to avoid a global installation of Python
-modules. ``make init`` will warn you if you do not.
+recommend that you use a virtual environment to avoid a global installation of
+Python modules. ``make init`` will warn you if you do not.
When editing documentation run ``make html-auto`` to view the results of your
edits. This target runs a local webserver at http://localhost:8000 which
serves
@@ -178,7 +178,6 @@ find documentation issues sort by the `documentation`_
label.
.. _ReStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://www.sphinx-doc.org
.. _Homebrew: https://brew.sh
-.. _virtualenv: https://virtualenv.pypa.io/en/latest/
.. _documentation: https://github.com/flycheck/flycheck/labels/documentation
Issue management
diff --git a/doc/index.rst b/doc/index.rst
index a02b3a72a9..a8a82d02ca 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -34,11 +34,11 @@ To try Flycheck in your Emacs session install some
:ref:`syntax checker tools
<flycheck-languages>` and type the following in your ``*scratch*`` buffer and
run ``M-x eval-buffer``:
-.. code-block:: cl
+.. code-block:: elisp
(require 'package)
(add-to-list 'package-archives
- '("MELPA Stable" . "http://stable.melpa.org/packages/";) t)
+ '("MELPA Stable" . "https://stable.melpa.org/packages/";) t)
(package-initialize)
(package-refresh-contents)
@@ -49,7 +49,7 @@ run ``M-x eval-buffer``:
*On macOS* also add the following to :ref:`fix your $PATH environment variable
<flycheck-macos-exec-path-from-shell>`:
-.. code-block:: cl
+.. code-block:: elisp
(package-install 'exec-path-from-shell)
(exec-path-from-shell-initialize)
