search

planetarium / libplanet

Blockchain in C#/.NET for on-chain, decentralized gaming
https://docs.libplanet.io/
GNU Lesser General Public License v2.1
506 stars 142 forks source link

DocFx on GitHub Actions are not working #1122

Closed moreal closed 3 years ago

moreal commented 3 years ago

Now, we build docs.libplanet.io documentation with DocFx on GitHub Actions. But it has been not working well for some links (e.g., cref element).

As I share my experience, in my environment, Windows 10, it works well and builds all links for all types correctly. Also, it didn't build documentation correctly though I tried to bump DocFx's version into v2.56.5.

moreal commented 3 years ago

It caused by logs during fetching metadata. As Libplanet.Net.ITransport case:

2020-12-07T13:08:27.2986787Z [20-12-07 01:08:27.298]Warning:[MetadataCommand.ExtractMetadata]Invalid cref value "!:EventHandler" found in triple-slash-comments for ProcessMessageHandler defined in ../Libplanet/Net/ITransport.cs Line 20, ignored.
2020-12-07T13:08:27.3099451Z [20-12-07 01:08:27.309]Warning:[MetadataCommand.ExtractMetadata]Invalid cref value "!:DateTimeOffset" found in triple-slash-comments for LastMessageTimestamp defined in ../Libplanet/Net/ITransport.cs Line 37, ignored.
2020-12-07T13:08:27.3120905Z [20-12-07 01:08:27.311]Warning:[MetadataCommand.ExtractMetadata]Invalid cref value "!:TimeSpan" found in triple-slash-comments for StopAsync defined in ../Libplanet/Net/ITransport.cs Line 68, ignored.
2020-12-07T13:08:27.3132178Z [20-12-07 01:08:27.312]Warning:[MetadataCommand.ExtractMetadata]Invalid cref value "!:IEnumerable<T>" found in triple-slash-comments for BootstrapAsync defined in ../Libplanet/Net/ITransport.cs Line 90, ignored.

You can also see https://github.com/dotnet/docfx/issues/6624 and related issues.