Comments (8)
Huuuum, I see. I guess you're right, type
of Sphinx is supposed to be a single type, not a complex string.
Tough part if that sphinx accepts it, even if they say they don't :p.
I don't like to point to a module, because it doesn't help that much. I probably should put a aka.ms/pyauth link into the description, and no type. Especially since msrest 0.6.0, there is an additional type possible HTTPPolicy
from autorest.python.
Another busted xref link is to the *Configuration instance variable for each client. Lemme know if you'd like a separate issue for this.
azure.mgmt.containerinstance.container_instance_management_client.containerinstancemanagementclien
azure.mgmt.authorization.authorization_management_client.authorizationmanagementclient
Looks like that's coming through from here: AzureServiceClientTemplate.cshtml
from autorest.python.
@mmacy I believe the syntax is correct from Autorest, and it's likely a doc issue for @dendeli-msft. I do my dev on Sphinx for the doc, and it worked at some point (didn't tested recently).
I would expect a link to this:
https://docs.microsoft.com/en-us/python/api/msrestazure/msrestazure.azure_active_directory?view=azure-python
from autorest.python.
@lmazuel @dendeli-msft Thanks Laurent. I ran a test at one point, removing the comment and specifying just the type, and it rendered OK:
Here's the diff: diff
And the YAML that popped out:
from autorest.python.
@lmazuel Ping... 🔔
from autorest.python.
Hi @mmacy
I just created the aka.ms https://aka.ms/pysdkauth
@mmacy , I see here you are able to run test easily, would it be possible for you to test if there is a syntax that the doc processor accept in type
for a simple link? Maybe just writing https://aka.ms/pysdkauth
, or :link:https://aka.ms/pysdkauth
or something else, I don't know out of my head right now.
I can also play a little with Sphinx, but Sphinx supports way more thing, so I won't be sure it will work with the doc.
Thanks!
from autorest.python.
@lmazuel Looks like Markdown link format works:
EDIT: However, that's in a :param:
. I'll do some more investigation.
from autorest.python.
Will be fixed in new autorest with azure-identity link
from autorest.python.
Related Issues (20)
- Sample generation Implementation
- "All required parameters must be populated in order to send to server" - comment added in wrong classes HOT 2
- [TSP] Generate Models-only package
- [Typespec-python] @api_version_validation populating on overloads
- Stop generating with JSON payload description comments
- support naming optimization for snake case
- python emitter always pad specific enum name (e.g. int)
- [versioning] add clear doc to inform customer risk to set api-version other than the latest one
- [Typepsec] Support flexible output folder
- deserialization issue following moving to new requests and responses HOT 2
- add back stream response reading for paging
- [eng] pipeline to regenerate all existing packages from Typespec HOT 1
- have release pipeline depend on passage of ci post-merge
- Question: unexpected markdown docstring in RLC code HOT 2
- [azurefleet] SDK generation fails from Typespec
- Questions about versioning HOT 1
- [eng] Fake warning about changelog in nightly pipeline HOT 1
- [typespec-python] `accept` is not defined in generated build request method HOT 1
- [typespec-python] 'Content-Type' is not included in response_headers HOT 2
- Unexpected `\` in docstring HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from autorest.python.