Skip to content

Core doc fix #7638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lmazuel merged 5 commits into from
Oct 5, 2019
Merged

Core doc fix #7638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
594fc29
Fix azure-core examples
lmazuel Oct 4, 2019
388aa2b
Fix azure-core Readme
lmazuel Oct 4, 2019
23e2f69
Simplify doc
lmazuel Oct 4, 2019
e34530a
Kill common.py file
lmazuel Oct 4, 2019
9d143bb
Remove tracing.ext
lmazuel Oct 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 0 additions & 92 deletions doc/sphinx/ref/azure.core.pipeline.policies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,98 +1,6 @@
azure.core.pipeline.policies package
====================================

Submodules
----------

azure.core.pipeline.policies.authentication module
--------------------------------------------------

.. automodule:: azure.core.pipeline.policies.authentication
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.authentication\_async module
---------------------------------------------------------

.. automodule:: azure.core.pipeline.policies.authentication_async
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.base module
----------------------------------------

.. automodule:: azure.core.pipeline.policies.base
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.base\_async module
-----------------------------------------------

.. automodule:: azure.core.pipeline.policies.base_async
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.custom\_hook module
------------------------------------------------

.. automodule:: azure.core.pipeline.policies.custom_hook
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.distributed\_tracing module
--------------------------------------------------------

.. automodule:: azure.core.pipeline.policies.distributed_tracing
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.redirect module
--------------------------------------------

.. automodule:: azure.core.pipeline.policies.redirect
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.redirect\_async module
---------------------------------------------------

.. automodule:: azure.core.pipeline.policies.redirect_async
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.retry module
-----------------------------------------

.. automodule:: azure.core.pipeline.policies.retry
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.retry\_async module
------------------------------------------------

.. automodule:: azure.core.pipeline.policies.retry_async
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.policies.universal module
---------------------------------------------

.. automodule:: azure.core.pipeline.policies.universal
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

Expand Down
20 changes: 0 additions & 20 deletions doc/sphinx/ref/azure.core.pipeline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,6 @@ Subpackages
azure.core.pipeline.policies
azure.core.pipeline.transport

Submodules
----------

azure.core.pipeline.base module
-------------------------------

.. automodule:: azure.core.pipeline.base
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.base\_async module
--------------------------------------

.. automodule:: azure.core.pipeline.base_async
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

Expand Down
52 changes: 0 additions & 52 deletions doc/sphinx/ref/azure.core.pipeline.transport.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,6 @@
azure.core.pipeline.transport package
=====================================

Submodules
----------

azure.core.pipeline.transport.aiohttp module
--------------------------------------------

.. automodule:: azure.core.pipeline.transport.aiohttp
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.transport.base module
-----------------------------------------

.. automodule:: azure.core.pipeline.transport.base
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.transport.base\_async module
------------------------------------------------

.. automodule:: azure.core.pipeline.transport.base_async
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.transport.requests\_asyncio module
------------------------------------------------------

.. automodule:: azure.core.pipeline.transport.requests_asyncio
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.transport.requests\_basic module
----------------------------------------------------

.. automodule:: azure.core.pipeline.transport.requests_basic
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline.transport.requests\_trio module
---------------------------------------------------

.. automodule:: azure.core.pipeline.transport.requests_trio
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

Expand Down
20 changes: 0 additions & 20 deletions doc/sphinx/ref/azure.core.polling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,6 @@
azure.core.polling package
==========================

Submodules
----------

azure.core.polling.async\_poller module
---------------------------------------

.. automodule:: azure.core.polling.async_poller
:members:
:undoc-members:
:show-inheritance:

azure.core.polling.poller module
--------------------------------

.. automodule:: azure.core.polling.poller
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

Expand Down
48 changes: 0 additions & 48 deletions doc/sphinx/ref/azure.core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,6 @@ azure.core.async\_paging module
:undoc-members:
:show-inheritance:

azure.core.common module
------------------------

.. automodule:: azure.core.common
:members:
:undoc-members:
:show-inheritance:

azure.core.configuration module
-------------------------------

.. automodule:: azure.core.configuration
:members:
:undoc-members:
:show-inheritance:

azure.core.credentials module
-----------------------------

Expand All @@ -53,14 +37,6 @@ azure.core.exceptions module
:undoc-members:
:show-inheritance:

azure.core.match\_conditions module
-----------------------------------

.. automodule:: azure.core.match_conditions
:members:
:undoc-members:
:show-inheritance:

azure.core.paging module
------------------------

Expand All @@ -69,22 +45,6 @@ azure.core.paging module
:undoc-members:
:show-inheritance:

azure.core.pipeline\_client module
----------------------------------

.. automodule:: azure.core.pipeline_client
:members:
:undoc-members:
:show-inheritance:

azure.core.pipeline\_client\_async module
-----------------------------------------

.. automodule:: azure.core.pipeline_client_async
:members:
:undoc-members:
:show-inheritance:

azure.core.settings module
--------------------------

Expand All @@ -93,14 +53,6 @@ azure.core.settings module
:undoc-members:
:show-inheritance:

azure.core.version module
-------------------------

.. automodule:: azure.core.version
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------
Expand Down
9 changes: 0 additions & 9 deletions doc/sphinx/ref/azure.core.tracing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,9 @@
azure.core.tracing package
==========================


Submodules
----------

azure.core.tracing.abstract\_span module
----------------------------------------

.. automodule:: azure.core.tracing.abstract_span
:members:
:undoc-members:
:show-inheritance:

azure.core.tracing.common module
--------------------------------

Expand Down
3 changes: 2 additions & 1 deletion sdk/core/azure-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ The Python implementation of the pipeline has some mechanisms specific to Python
When constructing an SDK, a developer may consume the pipeline like so:

```python
from azure.core import Configuration, Pipeline
from azure.core.configuration import Configuration
from azure.core.pipeline import Pipeline
from azure.core.transport import RequestsTransport, HttpRequest
from azure.core.pipeline.policies import (
UserAgentPolicy,
Expand Down
32 changes: 0 additions & 32 deletions sdk/core/azure-core/azure/core/common.py
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion sdk/core/azure-core/examples/test_example_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ async def test_example_async_pipeline_client():
url = "https://bing.com"

# [START build_async_pipeline_client]
from azure.core import Configuration, AsyncPipelineClient
from azure.core import AsyncPipelineClient
from azure.core.configuration import Configuration
from azure.core.pipeline.policies import AsyncRedirectPolicy, UserAgentPolicy
from azure.core.pipeline.transport import HttpRequest

Expand Down
2 changes: 1 addition & 1 deletion sdk/core/azure-core/examples/test_example_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@


# [START configuration]
from azure.core import Configuration
from azure.core.configuration import Configuration
from azure.core.pipeline import Pipeline
from azure.core.pipeline.transport import RequestsTransport
from azure.core.pipeline.policies import (
Expand Down
2 changes: 1 addition & 1 deletion sdk/core/azure-core/examples/test_example_sansio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import sys
from azure.core.configuration import Configuration
from azure.core.pipeline.transport import HttpRequest
from azure.core.pipeline_client import PipelineClient
from azure.core import PipelineClient
from azure.core.pipeline.policies import RedirectPolicy
from azure.core.pipeline.policies import UserAgentPolicy
from azure.core.pipeline.policies import SansIOHTTPPolicy
Expand Down
5 changes: 3 additions & 2 deletions sdk/core/azure-core/examples/test_example_sync.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

from azure.core.configuration import Configuration
from azure.core.pipeline import Pipeline
from azure.core.pipeline_client import PipelineClient
from azure.core import PipelineClient
from azure.core.pipeline.transport import HttpRequest
from azure.core.pipeline.policies import (
UserAgentPolicy,
Expand Down Expand Up @@ -77,7 +77,8 @@ def test_example_pipeline():
def test_example_pipeline_client():
url = "https://bing.com"
# [START build_pipeline_client]
from azure.core import Configuration, PipelineClient
from azure.core import PipelineClient
from azure.core.configuration import Configuration
from azure.core.pipeline.policies import RedirectPolicy, UserAgentPolicy

# example configuration with some policies
Expand Down