azure-sdk-for-python icon indicating copy to clipboard operation
azure-sdk-for-python copied to clipboard

azure-mgmt-quota fails reference docs CI

Open danieljurek opened this issue 3 years ago • 6 comments

Cannot produce SDK API Reference Documentation for azure-mgmt-quota because of errors in the docs CI process.

Instructions to fix:

  1. Fix issue in package code to eliminate this error and check into main branch
  2. Ensure output is correct in daily docs build (see @danieljurek or @sima-zhu for details)
  3. Remove entry from $PackageExclusions in Language-Settings.ps1

Build: https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=260142&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b&t=1e77462e-7711-551f-cf20-c31b880b493a&l=28529


<Matched Warning>: D:\a\1\s\dist_temp\83\azure-mgmt-quota-1.0.0a20211020001\doc\azure.mgmt.quota.aio.rst:4: WARNING: error while formatting arguments for azure.mgmt.quota.aio.AzureQuotaExtensionAPI: name 'AsyncTokenCredential' is not defined

##[error]<Matched Error>: C:\hostedtoolcache\windows\Python\3.6.8\x64\lib\site-packages\azure\mgmt\quota\aio\operations\__init__.py:docstring of azure.mgmt.quota.aio.operations.QuotaRequestStatusOperations.list:10: ERROR: Error parsing content block for the "list-table" directive: uniform two-level bullet list expected, but row 2 does not contain the same number of items as row 1 (1 vs 2).
.. list-table::
   :header-rows: 1
   * - Field

<Matched Warning>: C:\hostedtoolcache\windows\Python\3.6.8\x64\lib\site-packages\azure\mgmt\quota\aio\operations\__init__.py:docstring of azure.mgmt.quota.aio.operations.QuotaRequestStatusOperations.list:19: WARNING: Inline substitution_reference start-string without end-string.

##[error]     - Supported operators
   * -



danieljurek avatar Oct 21 '21 22:10 danieljurek

Is there any possibility of getting these documents generated at this point in time?

DuneganS avatar Sep 12 '22 20:09 DuneganS

@DuneganS https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/612/Use-Docker-for-Package-Validation?anchor=reproduce-the-docker-errors

Here is the wiki for you to validate the errors in local. Ping me if anything unclear

sima-zhu avatar Sep 13 '22 22:09 sima-zhu

@DuneganS If the docs passed the validation, then we can add the package back to docs.

sima-zhu avatar Sep 13 '22 23:09 sima-zhu

Both of links as part of this inc show that I do not have access (and there is no way to request)

DuneganS avatar Sep 13 '22 23:09 DuneganS

Also interested in getting this documentation @sima-zhu

ajhous44 avatar Sep 21 '22 14:09 ajhous44

@DuneganS @ajhous44 Sorry for late reply. We grant the permission for all internal employees I think. If you are external customers, you can't run the internal docker, so the docs doesn't apply to you.

sima-zhu avatar Sep 22 '22 21:09 sima-zhu

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[bot] avatar Mar 13 '24 18:03 github-actions[bot]