sphinxcontrib-dotnetdomain
sphinxcontrib-dotnetdomain copied to clipboard
readthedocs
A Sphinx domain for .NET languages
`sphinxcontrib\dotnetdomain.py:L11 from sphinx.locale import l_` However, an exception is thrown indicating that `sphinxcontrib.dotnetdomain (exception: cannot import name 'l_')` Is there anything wrong?
For example, the following remark that `ShutdownTimout` defaults to 5 seconds in [KestrelServerOptions.cs](https://github.com/aspnet/KestrelHttpServer/blob/972be6e8c18d1ca1b0b8435dd6ba4526154df100/src/Microsoft.AspNetCore.Server.Kestrel/KestrelServerOptions.cs) doesn't show up in [the generated api docs](https://docs.asp.net/projects/api/en/latest/autoapi/Microsoft/AspNetCore/Server/Kestrel/KestrelServerOptions/index.html?highlight=kestrelserveroptions#prop-Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions.ShutdownTimeout): ``` c# /// /// The amount of time after...
When referencing a class with a name ending in "Attribute" using the `~` syntax, as in the example below, it would be good if the "Attribute" suffix could be stripped...
According to the [Sphinx docs](http://www.sphinx-doc.org/en/stable/domains.html#cross-referencing-syntax) cross referencing syntax should work with domain links. In the ASP.NET docs if I have this: ``` :dn:iface:`Microsoft.Extensions.Configuration.IConfiguration` ``` It renders a link like this:...
I have a link to the `HttpContext.Session`property link like this: `:dn:prop:`Microsoft.AspNet.Http.HttpContext.Session`` The generated URL is: http://docs.asp.net/projects/api/en/latest/autoapi/Microsoft/AspNet/Http/HttpContext/index.html#Microsoft.AspNet.Http.HttpContext.Session But this just goes to the HttpContext class page, instead of going right to...
Generally, I would expect to see type members listed roughly in this order: - constructors - properties - methods - fields - operators - indexers - events Currently the order...
Logging: ``` Microsoft.Framework.Logging.Console.ConsoleLogger.ConsoleLogger(System.String, System.Func) Microsoft.Framework.Logging.Console.ConsoleLoggerProvider.ConsoleLoggerProvider(System.Func) Microsoft.Framework.Logging.Debug.DebugLogger.DebugLogger(System.String) Microsoft.Framework.Logging.Debug.DebugLogger.DebugLogger(System.String, System.Func) Microsoft.Framework.Logging.Debug.DebugLoggerProvider.DebugLoggerProvider(System.Func) Microsoft.Framework.Logging.Internal.FormattedLogValues.FormattedLogValues(System.String, System.Object[]) Microsoft.Framework.Logging.Internal.LogValuesFormatter.LogValuesFormatter(System.String) Microsoft.Framework.Logging.Logger.Logger(Microsoft.Framework.Logging.ILoggerFactory) Microsoft.Framework.Logging.NLog.NLogLoggerProvider.NLogLoggerProvider(LogFactory) Microsoft.Framework.Logging.TraceSource.TraceSourceLoggerProvider.TraceSourceLoggerProvider(System.Diagnostics.SourceSwitch, System.Diagnostics.TraceListener) ``` Configuration: ``` Microsoft.Framework.Configuration.CommandLine.CommandLineConfigurationSource.CommandLineConfigurationSource(System.Collections.Generic.IEnumerable, System.Collections.Generic.IDictionary) Microsoft.Framework.Configuration.ConfigurationBuilder.ConfigurationBuilder(Microsoft.Framework.Configuration.IConfigurationSource[]) Microsoft.Framework.Configuration.ConfigurationBuilder.ConfigurationBuilder(System.String, Microsoft.Framework.Configuration.IConfigurationSource[]) Microsoft.Framework.Configuration.ConfigurationSection.ConfigurationSection(System.Collections.Generic.IList) Microsoft.Framework.Configuration.ConfigurationSection.Item[System.String] Microsoft.Framework.Configuration.ConfigurationSource.ConfigurationSource() Microsoft.Framework.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.EnvironmentVariablesConfigurationSource() Microsoft.Framework.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.EnvironmentVariablesConfigurationSource(System.String) Microsoft.Framework.Configuration.IConfiguration.Item[System.String]...
Unknown brace syntax is `Foo.Bar{`1}` Found an unknown brace syntax, failing test here: https://github.com/rtfd/sphinxcontrib-dotnetdomain/blob/083dccdf42b2f960f41770e57e34f1cf668df2de/tests/test_signature.py#L96-L100
This is an overview of some issues that were surfaced with the dotnet domain specification. These issues will be addressed in separate pull requests. - [x] `Foo` is invalid, would...
The current syntax was designed around C# usage, do we support a declaration syntax, or namespace nesting convention of, VB or F#? This was raised as part of feedback on...