Comments (6)
the fact that DocFX expects a particular repo layout in order to operate by default correctly totally sucks π π° π³
DocFX uses docfx init
to generate a docfx.json
file that promises π° π³ to be reconfigured for other repo layouts than the default
from songhaycore.
π dotnet/docfx#1752
the referenced above issue reveals that DocFX takes out a dependency on MSBuild which signals π₯ to me that this product is not firmly in the .NET Core timeframe
from songhaycore.
as of this writing, DocFX is so not what i need it is difficult to put into words how much it disappoints:
- its concerns are well beyond turning
*.csproj
documentation XML into an HTML page - it is more like a specialized static site generator which might be great for Swagger-ish APIs?
- the official documentation seems to not recognize the existence of the contents of
docfx.json
what is worse is the default behavior of enabling this in Visual Studio:
by default, an absolute path will be generated for DocumentationFile
in *.csproj
βin the modern .NET Core timeframe π
from songhaycore.
i am going to rollback my interest in DocFX for the time being π’
the story so far:
- NDoc is still stuck on SourceForge
- SandCastle was announced as a replacement for NDoc in 2006
- βIn October 2012, Microsoft officially declared that they were ceasing support and development of Sandcastle.β
- .NET Core 1.0 was released on June 27, 2016
- βDocumenting your code with XML commentsβ was last touched in 2017 and still presents Sandcastle as a thing
from songhaycore.
http://www.doxygen.nl/manual/starting.html
https://softwarerecs.stackexchange.com/questions/39227/net-documentation-generator-alternatives-to-sandcastle/39228
from songhaycore.
this video is supposed to revive my interest in DocFX:
https://www.youtube.com/watch?v=azONWe0dqtU&t=20s
Nothing so farβ¦
from songhaycore.
Related Issues (20)
- change `StreamReaderExtensions.ReadLines` to `break` out of the `while` loop
- add `ByteExtensions` to support ASP.NET file-upload scenarios
- add new members to `IDictionaryExtensions` HOT 1
- consider adding a `Result<T1,T2>` type to provide alternative methods that do not throw exceptions
- review code for βBest practices for comparing strings in .NETβ HOT 1
- remove `DebuggerAttached*` attribute definitions ππ₯
- The name `ConvertDateTimeToUtc` confuses date formats and time zones HOT 1
- add `IPrincipalExtensions`
- add `ILoggerExtensions` and a dependency on `Microsoft.Extensions.Logging`
- add `MenuDisplayItemModelExtensions.GetAllBy` method
- add `IServiceProviderExtensions`
- add `TestScalars`
- update `Orderers` classes
- add `ProgramUtility.GetConsoleIndentation` π¨ β¨
- add `DbDataReaderExtensions` π β¨
- the .NET Hosted Service (`IHostedService`) and the Songhay Activity (`IActivity`)
- the .NET `ILogger` interface and the Songhay Activity `IActivity`
- `IActivityWithTask*` should not inherit from `IActivity` π¨π₯
- the `--activity-name` parameter needs to be added to `ConsoleArgsScalars`
- `GetSettingsFilePath` is not returning a path but file content
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 songhaycore.