statiqdev / Statiq.Docs

A static documentation site generator.
https://statiq.dev/docs
Other
53 stars 8 forks source link

Nested types cause URL conflicts for Docs recipe #38

Open KellyThomas opened 6 years ago

KellyThomas commented 6 years ago

When using the Docs recipe on an code base with nested types there can be name conflicts.

For example when running the recipe against this code:

namespace Demo
{
    public class Temperature
    {
        public enum Mode { Hot, Cold }
    }

    public class Orientation
    {
        public enum Mode { North, South }
    }
}

It produces this error:

Multiple documents output to api/Demo/Mode/index.html (this probably wasn't intended):
  Demo.Orientation.Mode
  Demo.Temperature.Mode
SilentSin commented 5 years ago

I just ran into this issue as well. I would have expected Demo.Temperature.Mode to generate documentation at api/Demo/Temperature/Mode/index.html which would avoid the conflict.