Skip to content
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

Jump to bottom

azure-mgmt-signalr Ref docs build errors #18085

Closed
danieljurek opened this issue Apr 15, 2021 · 1 comment
Closed

azure-mgmt-signalr Ref docs build errors #18085

danieljurek opened this issue Apr 15, 2021 · 1 comment
Labels
Docs

Comments

@danieljurek
Copy link
Member

danieljurek commented Apr 15, 2021 •
edited
Loading

Build: https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=208214&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b&t=348f8a99-4a85-56c7-5436-e2f3858e80ba&l=31838

Looks like associated code for one of the errors: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/signalr/azure-mgmt-signalr/azure/mgmt/signalr/models/_models.py#L1379

To fix:

  • Go into source code, make fixes
  • From the package directory, run tox -e sphinx -c ../../../eng/tox/tox.ini
  • Look for docs location in console output
...


<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\models\__init__.py:docstring of azure.mgmt.signalr.models.UpstreamTemplate:35: WARNING: Explicit markup ends without a blank line; unexpected unindent.

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\models\__init__.py:docstring of azure.mgmt.signalr.models.UpstreamTemplate:37: WARNING: Definition list ends without a blank line; unexpected unindent.

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\models\__init__.py:docstring of azure.mgmt.signalr.models.FeatureFlags:5: WARNING: Bullet list ends without a blank line; unexpected unindent.

looking for now-outdated files... none found
pickling environment... done
<Matched Warning>: D:\a\1\s\dist_temp\85\azure-mgmt-signalr-1.0.0b1\doc\azure.mgmt.signalr.rst:: WARNING: document isn't included in any toctree

checking consistency... done
preparing documents... done
writing output... [ 16%] azure.mgmt.signalr                                    
writing output... [ 33%] azure.mgmt.signalr.aio                                
##[error].. code-block::
   1. "*", it to matches any hub name
   2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2"
   3. The single hub name, for example, "hub1", it matches "hub1".
<Matched Error>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\models\__init__.py:docstring of azure.mgmt.signalr.models.UpstreamTemplate:20: ERROR: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::

writing output... [ 50%] azure.mgmt.signalr.aio.operations                     
writing output... [ 66%] azure.mgmt.signalr.models                             
writing output... [ 83%] azure.mgmt.signalr.operations                         
writing output... [100%] index                                                 

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\__init__.py:docstring of azure.mgmt.signalr.SignalRManagementClient:None: WARNING: more than one target found for cross-reference 'operations': azure.mgmt.signalr.aio.operations, azure.mgmt.signalr.operations

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\aio\__init__.py:docstring of azure.mgmt.signalr.aio.SignalRManagementClient:None: WARNING: more than one target found for cross-reference 'operations': azure.mgmt.signalr.aio.operations, azure.mgmt.signalr.operations

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\aio\operations\__init__.py:docstring of azure.mgmt.signalr.aio.operations.Operations:None: WARNING: more than one target found for cross-reference 'models': azure.mgmt.signalr.aio.operations.Operations.models, azure.mgmt.signalr.aio.operations.SignalROperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.aio.operations.UsagesOperations.models, azure.mgmt.signalr.models, azure.mgmt.signalr.operations.Operations.models, azure.mgmt.signalr.operations.SignalROperations.models, azure.mgmt.signalr.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.operations.UsagesOperations.models

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\aio\operations\__init__.py:docstring of azure.mgmt.signalr.aio.operations.SignalROperations:None: WARNING: more than one target found for cross-reference 'models': azure.mgmt.signalr.aio.operations.Operations.models, azure.mgmt.signalr.aio.operations.SignalROperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.aio.operations.UsagesOperations.models, azure.mgmt.signalr.models, azure.mgmt.signalr.operations.Operations.models, azure.mgmt.signalr.operations.SignalROperations.models, azure.mgmt.signalr.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.operations.UsagesOperations.models

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\aio\operations\__init__.py:docstring of azure.mgmt.signalr.aio.operations.SignalRPrivateEndpointConnectionsOperations:None: WARNING: more than one target found for cross-reference 'models': azure.mgmt.signalr.aio.operations.Operations.models, azure.mgmt.signalr.aio.operations.SignalROperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.aio.operations.UsagesOperations.models, azure.mgmt.signalr.models, azure.mgmt.signalr.operations.Operations.models, azure.mgmt.signalr.operations.SignalROperations.models, azure.mgmt.signalr.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.operations.UsagesOperations.models

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\aio\operations\__init__.py:docstring of azure.mgmt.signalr.aio.operations.SignalRPrivateLinkResourcesOperations:None: WARNING: more than one target found for cross-reference 'models': azure.mgmt.signalr.aio.operations.Operations.models, azure.mgmt.signalr.aio.operations.SignalROperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.aio.operations.UsagesOperations.models, azure.mgmt.signalr.models, azure.mgmt.signalr.operations.Operations.models, azure.mgmt.signalr.operations.SignalROperations.models, azure.mgmt.signalr.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.operations.UsagesOperations.models

<Matched Warning>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\aio\operations\__init__.py:docstring of azure.mgmt.signalr.aio.operations.UsagesOperations:None: WARNING: more than one target found for cross-reference 'models': azure.mgmt.signalr.aio.operations.Operations.models, azure.mgmt.signalr.aio.operations.SignalROperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.aio.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.aio.operations.UsagesOperations.models, azure.mgmt.signalr.models, azure.mgmt.signalr.operations.Operations.models, azure.mgmt.signalr.operations.SignalROperations.models, azure.mgmt.signalr.operations.SignalRPrivateEndpointConnectionsOperations.models, azure.mgmt.signalr.operations.SignalRPrivateLinkResourcesOperations.models, azure.mgmt.signalr.operations.UsagesOperations.models
##[error]   1. "*", it to matches any event name
   2. Combine multiple events with ",", for example "connect,disconnect", it matches event
<Matched Error>: c:\hostedtoolcache\windows\python\3.6.8\x64\lib\site-packages\azure\mgmt\signalr\models\__init__.py:docstring of azure.mgmt.signalr.models.UpstreamTemplate:31: ERROR: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
   1. "*", it to matches any category name
   2. Combine multiple categories with ",", for example "connections,messages", it matches


...
@danieljurek danieljurek mentioned this issue Apr 15, 2021
Closed
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-python that referenced this issue Mar 7, 2022
@debroy @debjyoti11
@roeybc @laithhisham @ushasan @hassanchawiche @shschwar @royrein @dosegal @akning-ms
CodeGen from PR 18025 in Azure/azure-rest-api-specs
4b75938 
Dev sentinel 2022 01 01 preview (Azure#18025)

* Adds base for updating Microsoft.SecurityInsights from version preview/2021-10-01-preview to version 2022-01-01-preview

* Updates readme

* Updates API version in new specs and examples

* SourceControl API 2022-01-01-preview version - adding new attribute to SourceControl model (Azure#17849)

* SourceControl 2022-01-01-preview version change

* fix validation error

* prettified

* prettified

Co-authored-by: debjyoti11 <[email protected]>

* New metadata API (Azure#17942)

* metadata changes

* addressed changes

* updated enum kind

* updated values as well

Co-authored-by: Roey Ben Chaim <[email protected]>

* added new enum to kind (Azure#17994)

Co-authored-by: Roey Ben Chaim <[email protected]>

* Add flag to rotate webhook secret (Azure#17989)

Co-authored-by: debjyoti11 <[email protected]>

* Align definitions with stable version (Azure#17931)

* Align definitions with stable version

* align scheduled rule and template properties with stable

* Note: We are creating a new api-version with this change. Watchlists.json 2022-01-01-preview parameter name changes (Azure#17848)

* changed source to sourceType and watchlistAlias to alias

* Update CreateWatchlistAndWatchlistItems.json

* Update CreateWatchlistItem.json

* Update DeleteWatchlist.json

* Update DeleteWatchlistItem.json

* Update GetWatchlistByAlias.json

* Update GetWatchlistItemById.json

* Update GetWatchlistItems.json

* Update GetWatchlistByAlias.json

* added missing params to match stable version

* Revert "added missing params to match stable version"

This reverts commit a30a709613f94266d0eaba6495c92be43221a282.

Reverting by 1 commit

* refreshing pipeline

* reverting lint diff change

* attempting to fix RemovedPath breaking changes

* Revert "attempting to fix RemovedPath breaking changes"

This reverts commit 2f96ee3c050fde4c166bf730b0a1b5faff07cfc1.

reverting attempt at correcting breaking changes. cannot match preview
to stable without breaking everything.

* adding back source type for backwards compatibility, added response descriptions, corrected PR comments

* adding missing bracket

* ran npm run prettier-fix to correct style issues

* resolving model/definition errors

* Revert "resolving model/definition errors"

This reverts commit fd67a4f813d923965cefad50999010820446a107.

Reverting prettier changes made to other branches

* Revert "ran npm run prettier-fix to correct style issues"

This reverts commit 3055791e00e956fff3a62e24d8313dde96daa00c.

* update

* Update DeleteWatchlist.json

* Update Watchlists.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* fixing styling issues on Delete example

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* ran npm run prettier on DeleteWatchlist.json

* Update Watchlists.json

* reverting alias to watchlistAlias

Co-authored-by: Hassan Chawiche <[email protected]>

* Rename system to AutoAssigned (Azure#18061)

* Rename system to AutoAssigned

* Add example to list operations

* Update API version in NRT examples

* Execute validation tools and fix results (Azure#17733)

* Execute validation tools and fic results

* Prettyfieir GetIoTById.json

* Watchlists.json-2022-01-01-preview-parameterNameChanges (reverted PR reference for files changed -> https://github.com/Azure/azure-rest-api-specs/pull/17848/files) (Azure#18085)

* changed source to sourceType and watchlistAlias to alias

* Update CreateWatchlistAndWatchlistItems.json

* Update CreateWatchlistItem.json

* Update DeleteWatchlist.json

* Update DeleteWatchlistItem.json

* Update GetWatchlistByAlias.json

* Update GetWatchlistItemById.json

* Update GetWatchlistItems.json

* Update GetWatchlistByAlias.json

* added missing params to match stable version

* Revert "added missing params to match stable version"

This reverts commit a30a709613f94266d0eaba6495c92be43221a282.

Reverting by 1 commit

* refreshing pipeline

* reverting lint diff change

* attempting to fix RemovedPath breaking changes

* Revert "attempting to fix RemovedPath breaking changes"

This reverts commit 2f96ee3c050fde4c166bf730b0a1b5faff07cfc1.

reverting attempt at correcting breaking changes. cannot match preview
to stable without breaking everything.

* adding back source type for backwards compatibility, added response descriptions, corrected PR comments

* adding missing bracket

* ran npm run prettier-fix to correct style issues

* resolving model/definition errors

* Revert "resolving model/definition errors"

This reverts commit fd67a4f813d923965cefad50999010820446a107.

Reverting prettier changes made to other branches

* Revert "ran npm run prettier-fix to correct style issues"

This reverts commit 3055791e00e956fff3a62e24d8313dde96daa00c.

* update

* Update DeleteWatchlist.json

* Update Watchlists.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* fixing styling issues on Delete example

* Update DeleteWatchlist.json

* Update DeleteWatchlist.json

* ran npm run prettier on DeleteWatchlist.json

* Update Watchlists.json

* reverting alias to watchlistAlias

* fixing type version

* Update Watchlists.json

* Update DeleteWatchlist.json

* fixing commas

Co-authored-by: Hassan Chawiche <[email protected]>
Co-authored-by: Usman Hasan <[email protected]>

* Done (Azure#17843)

Co-authored-by: Roy Reinhorn <[email protected]>

* AutomationRules 2022-01-01-preview: Add constraints (Azure#18099)

* add contraints (alinged with the latest stable version)

Co-authored-by: debroy <[email protected]>
Co-authored-by: debjyoti11 <[email protected]>
Co-authored-by: RoeyBC <[email protected]>
Co-authored-by: Roey Ben Chaim <[email protected]>
Co-authored-by: Laith Hisham <[email protected]>
Co-authored-by: ushasan <[email protected]>
Co-authored-by: Hassan Chawiche <[email protected]>
Co-authored-by: shschwar <[email protected]>
Co-authored-by: Usman Hasan <[email protected]>
Co-authored-by: royrein <[email protected]>
Co-authored-by: Roy Reinhorn <[email protected]>
Co-authored-by: dosegal <[email protected]>
Co-authored-by: Arthur Ning <[email protected]>
@github-actions GitHub Actions
Copy link

Hi @danieljurek, we deeply appreciate your input into this project. Regrettably, this issue has remained inactive for over 2 years, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 15, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Mar 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@danieljurek