saymrwulf/cryptography
1
0
Fork 0
mirror of https://github.com/saymrwulf/cryptography.git synced 2026-05-14 20:37:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add instructions to build the docs (#11290)

Browse source 
* 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 <alex.gaynor@gmail.com>

---------

Co-authored-by: Alex Gaynor <alex.gaynor@gmail.com>
This commit is contained in:
Facundo Tuesca 2024-07-17 23:07:37 +02:00 committed by GitHub
parent 3c7a5e0738
commit 783223f5f6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/development/getting-started.rst
View file

@ -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