diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2023-12-09 09:36:46 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-09 08:36:46 -0600 |
| commit | 61676b5b05c32556712c4bf750598de9dc08527a (patch) | |
| tree | ccc559c2e46203bab5909f083d294b09c9d9a9e9 /docs | |
| parent | 737fd82ec9c5d32c781f1e62ecffd0823651ab23 (diff) | |
| download | pyca-cryptography-61676b5b05c32556712c4bf750598de9dc08527a.zip pyca-cryptography-61676b5b05c32556712c4bf750598de9dc08527a.tar.gz pyca-cryptography-61676b5b05c32556712c4bf750598de9dc08527a.tar.bz2 | |
Update development docs (#9977)
- No special configuration is required for brew or macports OpenSSL anymore
- There's no point in documenting building local docs, it's basically never necessary
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/getting-started.rst | 23 |
1 files changed, 2 insertions, 21 deletions
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst index ad4ffd9..2ef12cf 100644 --- a/docs/development/getting-started.rst +++ b/docs/development/getting-started.rst @@ -20,9 +20,8 @@ installed with ``pip``. OpenSSL on macOS ~~~~~~~~~~~~~~~~ -You must have installed `OpenSSL`_ (via `Homebrew`_ , `MacPorts`_, or a custom -build) and must configure the build `as documented here`_ before calling -``nox`` or else pip will fail to compile. +You must have installed `OpenSSL`_ (via `Homebrew`_ , `MacPorts`_) before +invoking ``nox`` or else pip will fail to compile. Running tests ------------- @@ -44,22 +43,6 @@ You can also specify a subset of tests to run as positional arguments: $ # run the whole x509 testsuite, plus the fernet tests $ nox -e tests -p py310 -- tests/x509/ tests/test_fernet.py -Building documentation ----------------------- - -``cryptography`` documentation is stored in the ``docs/`` directory. It is -written in `reStructured Text`_ and rendered using `Sphinx`_. - -Use `nox`_ to build the documentation. For example: - -.. code-block:: console - - $ nox -e docs - ... - nox > Session docs was successful. - -The HTML documentation index can now be found at -``docs/_build/html/index.html``. .. _`Homebrew`: https://brew.sh .. _`MacPorts`: https://www.macports.org @@ -68,6 +51,4 @@ The HTML documentation index can now be found at .. _`nox`: https://pypi.org/project/nox/ .. _`virtualenv`: https://pypi.org/project/virtualenv/ .. _`pip`: https://pypi.org/project/pip/ -.. _`sphinx`: https://pypi.org/project/Sphinx/ -.. _`reStructured Text`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html .. _`as documented here`: https://docs.rs/openssl/latest/openssl/#automatic |