docs: add reference documentation for docker.utils module#3411
Open
Piyush0049 wants to merge 1 commit into
Open
docs: add reference documentation for docker.utils module#3411Piyush0049 wants to merge 1 commit into
Piyush0049 wants to merge 1 commit into
Conversation
Signed-off-by: piyush0049 <piyushjoshi81204@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3386
Context
The
docker.utils.parse_env_fileutility function was added in version 1.4.0, but it was never documented in the Sphinx reference files. As a result, the changelog link to the docs has been pointing to an empty location, leaving users unaware of how to officially parse.envfiles usingdocker-py.Furthermore,
kwargs_from_env(the backbone ofdocker.from_env()) was completely missing a docstring.Changes Made
kwargs_from_envandparse_env_fileindocker/utils/utils.py.docs/utils.rstpage using the.. autofunction::directive to automatically pull the documentation.utilsreference page in thedocs/index.rsttoctree.Verification
make docs) successfully.