Skip to content

Commit f320eb7

Browse files
authored
Docs build and developer guide updates (#2956)
* Add note to docs build info * Add proxy env vars to proxy section
1 parent ccd593c commit f320eb7

2 files changed

Lines changed: 3 additions & 0 deletions

File tree

‎docs/README.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Documentation for boto3 can be found `here <https://boto3.amazonaws.com/v1/docum
44

55
Generating Documentation
66
~~~~~~~~~~~~~~~~~~~~~~~~
7+
Note: Botocore's `requirement-docs.txt <https://github.com/boto/botocore/blob/develop/requirements-docs.txt>`_ must be installed prior to attempting the following steps.
8+
79
Sphinx is used for documentation. You can generate HTML locally with the
810
following:
911

‎docs/source/guide/configuration.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ In the following example, a proxy list is set up to use ``proxy.amazon.com``, po
8383
8484
client = boto3.client('kinesis', config=my_config)
8585
86+
Alternatively, you can use the ``HTTP_PROXY`` and ``HTTPS_PROXY`` environment variables to specify proxy servers. The ``NO_PROXY`` environment variable can be used to override proxy servers set by ``HTTP_PROXY`` and ``HTTPS_PROXY``. Proxy servers specified using the ``proxies`` option in the ``Config`` object will override proxy servers specified using environment variables.
8687

8788
.. _configure_proxies:
8889

0 commit comments

Comments
 (0)