From 783223f5f65a326d2bea9978300cd81a658c8f00 Mon Sep 17 00:00:00 2001 From: Facundo Tuesca Date: Wed, 17 Jul 2024 23:07:37 +0200 Subject: [PATCH] docs: Add instructions to build the docs (#11290) * docs: Add instructions to build the docs * docs: Fix single backticks * docs: remove troubleshooting section * Update docs/development/getting-started.rst Co-authored-by: Alex Gaynor --------- Co-authored-by: Alex Gaynor --- docs/development/getting-started.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst index 2cb1bb478..d074718f4 100644 --- a/docs/development/getting-started.rst +++ b/docs/development/getting-started.rst @@ -41,6 +41,17 @@ You can also specify a subset of tests to run as positional arguments: $ # run the whole x509 testsuite, plus the fernet tests $ nox -e local -- tests/x509/ tests/test_fernet.py +Building the docs +----------------- + +Building the docs on non-Windows platforms requires manually installing +the C library ``libenchant`` (`installation instructions`_). +The docs can be built using ``nox``: + +.. code-block:: console + + $ nox -e docs + .. _`Homebrew`: https://brew.sh .. _`MacPorts`: https://www.macports.org @@ -50,3 +61,4 @@ You can also specify a subset of tests to run as positional arguments: .. _`virtualenv`: https://pypi.org/project/virtualenv/ .. _`pip`: https://pypi.org/project/pip/ .. _`as documented here`: https://docs.rs/openssl/latest/openssl/#automatic +.. _`installation instructions`: https://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library \ No newline at end of file