diff --git a/.gitignore b/.gitignore index 605ff0904..99546ca83 100644 --- a/.gitignore +++ b/.gitignore @@ -108,7 +108,6 @@ docs/.sass-cache/ docs/.docfx/ docs/obj/ docs/api/**.yml -!docs/api/toc.yml docs/api/.manifest docs/api/.xrefmap.json docs/api/.xrefmap.yml diff --git a/docs/api/index.md b/docs/api/index.md index 325ec550f..74a12d42f 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,5 +1,7 @@ # API Reference -The API reference is generated from the `Humanizer` assembly and its XML documentation. +The API reference is automatically generated from the `Humanizer` assembly and its XML documentation using DocFX. Use the table of contents to explore namespaces, types, and members. Each page links back to the corresponding source when available. + +The table of contents is generated automatically during the documentation build process and stays in sync with the codebase. diff --git a/docs/api/toc.yml b/docs/api/toc.yml deleted file mode 100644 index 293cab554..000000000 --- a/docs/api/toc.yml +++ /dev/null @@ -1,388 +0,0 @@ -### YamlMime:TableOfContent -items: -- uid: Humanizer - name: Humanizer - type: Namespace - items: - - uid: Humanizer.ByteRate - name: ByteRate - type: Class - - uid: Humanizer.ByteSize - name: ByteSize - type: Struct - - uid: Humanizer.ByteSizeExtensions - name: ByteSizeExtensions - type: Class - - uid: Humanizer.CasingExtensions - name: CasingExtensions - type: Class - - uid: Humanizer.ClockNotationRounding - name: ClockNotationRounding - type: Enum - - uid: Humanizer.CollectionHumanizeExtensions - name: CollectionHumanizeExtensions - type: Class - - uid: Humanizer.Configurator - name: Configurator - type: Class - - uid: Humanizer.DataUnit - name: DataUnit - type: Enum - - uid: Humanizer.DateHumanizeExtensions - name: DateHumanizeExtensions - type: Class - - uid: Humanizer.DateToOrdinalWordsExtensions - name: DateToOrdinalWordsExtensions - type: Class - - uid: Humanizer.DefaultDateOnlyHumanizeStrategy - name: DefaultDateOnlyHumanizeStrategy - type: Class - - uid: Humanizer.DefaultDateTimeHumanizeStrategy - name: DefaultDateTimeHumanizeStrategy - type: Class - - uid: Humanizer.DefaultDateTimeOffsetHumanizeStrategy - name: DefaultDateTimeOffsetHumanizeStrategy - type: Class - - uid: Humanizer.DefaultFormatter - name: DefaultFormatter - type: Class - - uid: Humanizer.DefaultTimeOnlyHumanizeStrategy - name: DefaultTimeOnlyHumanizeStrategy - type: Class - - uid: Humanizer.DynamicNumberOfCharactersAndPreserveWordsTruncator - name: DynamicNumberOfCharactersAndPreserveWordsTruncator - type: Class - - uid: Humanizer.EnglishArticle - name: EnglishArticle - type: Class - - uid: Humanizer.EnumDehumanizeExtensions - name: EnumDehumanizeExtensions - type: Class - - uid: Humanizer.EnumHumanizeExtensions - name: EnumHumanizeExtensions - type: Class - - uid: Humanizer.GrammaticalCase - name: GrammaticalCase - type: Enum - - uid: Humanizer.GrammaticalGender - name: GrammaticalGender - type: Enum - - uid: Humanizer.HeadingExtensions - name: HeadingExtensions - type: Class - - uid: Humanizer.HeadingStyle - name: HeadingStyle - type: Enum - - uid: Humanizer.ICollectionFormatter - name: ICollectionFormatter - type: Interface - - uid: Humanizer.ICulturedStringTransformer - name: ICulturedStringTransformer - type: Interface - - uid: Humanizer.IDateOnlyHumanizeStrategy - name: IDateOnlyHumanizeStrategy - type: Interface - - uid: Humanizer.IDateOnlyToOrdinalWordConverter - name: IDateOnlyToOrdinalWordConverter - type: Interface - - uid: Humanizer.IDateTimeHumanizeStrategy - name: IDateTimeHumanizeStrategy - type: Interface - - uid: Humanizer.IDateTimeOffsetHumanizeStrategy - name: IDateTimeOffsetHumanizeStrategy - type: Interface - - uid: Humanizer.IDateToOrdinalWordConverter - name: IDateToOrdinalWordConverter - type: Interface - - uid: Humanizer.IFormatter - name: IFormatter - type: Interface - - uid: Humanizer.INumberToWordsConverter - name: INumberToWordsConverter - type: Interface - - uid: Humanizer.IOrdinalizer - name: IOrdinalizer - type: Interface - - uid: Humanizer.IStringTransformer - name: IStringTransformer - type: Interface - - uid: Humanizer.ITimeOnlyHumanizeStrategy - name: ITimeOnlyHumanizeStrategy - type: Interface - - uid: Humanizer.ITimeOnlyToClockNotationConverter - name: ITimeOnlyToClockNotationConverter - type: Interface - - uid: Humanizer.ITruncator - name: ITruncator - type: Interface - - uid: Humanizer.IWordsToNumberConverter - name: IWordsToNumberConverter - type: Interface - - uid: Humanizer.In - name: In - type: Class - - uid: Humanizer.In.Eight - name: In.Eight - type: Class - - uid: Humanizer.In.Five - name: In.Five - type: Class - - uid: Humanizer.In.Four - name: In.Four - type: Class - - uid: Humanizer.In.Nine - name: In.Nine - type: Class - - uid: Humanizer.In.One - name: In.One - type: Class - - uid: Humanizer.In.Seven - name: In.Seven - type: Class - - uid: Humanizer.In.Six - name: In.Six - type: Class - - uid: Humanizer.In.Ten - name: In.Ten - type: Class - - uid: Humanizer.In.Three - name: In.Three - type: Class - - uid: Humanizer.In.Two - name: In.Two - type: Class - - uid: Humanizer.InDate - name: InDate - type: Class - - uid: Humanizer.InDate.Eight - name: InDate.Eight - type: Class - - uid: Humanizer.InDate.Five - name: InDate.Five - type: Class - - uid: Humanizer.InDate.Four - name: InDate.Four - type: Class - - uid: Humanizer.InDate.Nine - name: InDate.Nine - type: Class - - uid: Humanizer.InDate.One - name: InDate.One - type: Class - - uid: Humanizer.InDate.Seven - name: InDate.Seven - type: Class - - uid: Humanizer.InDate.Six - name: InDate.Six - type: Class - - uid: Humanizer.InDate.Ten - name: InDate.Ten - type: Class - - uid: Humanizer.InDate.Three - name: InDate.Three - type: Class - - uid: Humanizer.InDate.Two - name: InDate.Two - type: Class - - uid: Humanizer.InflectorExtensions - name: InflectorExtensions - type: Class - - uid: Humanizer.LetterCasing - name: LetterCasing - type: Enum - - uid: Humanizer.LocaliserRegistry`1 - name: LocaliserRegistry - type: Class - - uid: Humanizer.MetricNumeralExtensions - name: MetricNumeralExtensions - type: Class - - uid: Humanizer.MetricNumeralFormats - name: MetricNumeralFormats - type: Enum - - uid: Humanizer.NoMatchFoundException - name: NoMatchFoundException - type: Class - - uid: Humanizer.NumberToNumberExtensions - name: NumberToNumberExtensions - type: Class - - uid: Humanizer.NumberToTimeSpanExtensions - name: NumberToTimeSpanExtensions - type: Class - - uid: Humanizer.NumberToWordsExtension - name: NumberToWordsExtension - type: Class - - uid: Humanizer.On - name: On - type: Class - - uid: Humanizer.On.April - name: On.April - type: Class - - uid: Humanizer.On.August - name: On.August - type: Class - - uid: Humanizer.On.December - name: On.December - type: Class - - uid: Humanizer.On.February - name: On.February - type: Class - - uid: Humanizer.On.January - name: On.January - type: Class - - uid: Humanizer.On.July - name: On.July - type: Class - - uid: Humanizer.On.June - name: On.June - type: Class - - uid: Humanizer.On.March - name: On.March - type: Class - - uid: Humanizer.On.May - name: On.May - type: Class - - uid: Humanizer.On.November - name: On.November - type: Class - - uid: Humanizer.On.October - name: On.October - type: Class - - uid: Humanizer.On.September - name: On.September - type: Class - - uid: Humanizer.OnDate - name: OnDate - type: Class - - uid: Humanizer.OnDate.April - name: OnDate.April - type: Class - - uid: Humanizer.OnDate.August - name: OnDate.August - type: Class - - uid: Humanizer.OnDate.December - name: OnDate.December - type: Class - - uid: Humanizer.OnDate.February - name: OnDate.February - type: Class - - uid: Humanizer.OnDate.January - name: OnDate.January - type: Class - - uid: Humanizer.OnDate.July - name: OnDate.July - type: Class - - uid: Humanizer.OnDate.June - name: OnDate.June - type: Class - - uid: Humanizer.OnDate.March - name: OnDate.March - type: Class - - uid: Humanizer.OnDate.May - name: OnDate.May - type: Class - - uid: Humanizer.OnDate.November - name: OnDate.November - type: Class - - uid: Humanizer.OnDate.October - name: OnDate.October - type: Class - - uid: Humanizer.OnDate.September - name: OnDate.September - type: Class - - uid: Humanizer.OnNoMatch - name: OnNoMatch - type: Enum - - uid: Humanizer.OrdinalizeExtensions - name: OrdinalizeExtensions - type: Class - - uid: Humanizer.Plurality - name: Plurality - type: Enum - - uid: Humanizer.PrecisionDateOnlyHumanizeStrategy - name: PrecisionDateOnlyHumanizeStrategy - type: Class - - uid: Humanizer.PrecisionDateTimeHumanizeStrategy - name: PrecisionDateTimeHumanizeStrategy - type: Class - - uid: Humanizer.PrecisionDateTimeOffsetHumanizeStrategy - name: PrecisionDateTimeOffsetHumanizeStrategy - type: Class - - uid: Humanizer.PrecisionTimeOnlyHumanizeStrategy - name: PrecisionTimeOnlyHumanizeStrategy - type: Class - - uid: Humanizer.PrepositionsExtensions - name: PrepositionsExtensions - type: Class - - uid: Humanizer.ResourceKeys - name: ResourceKeys - type: Class - - uid: Humanizer.ResourceKeys.DateHumanize - name: ResourceKeys.DateHumanize - type: Class - - uid: Humanizer.ResourceKeys.TimeSpanHumanize - name: ResourceKeys.TimeSpanHumanize - type: Class - - uid: Humanizer.ResourceKeys.TimeUnitSymbol - name: ResourceKeys.TimeUnitSymbol - type: Class - - uid: Humanizer.Resources - name: Resources - type: Class - - uid: Humanizer.RomanNumeralExtensions - name: RomanNumeralExtensions - type: Class - - uid: Humanizer.ShowQuantityAs - name: ShowQuantityAs - type: Enum - - uid: Humanizer.StringDehumanizeExtensions - name: StringDehumanizeExtensions - type: Class - - uid: Humanizer.StringHumanizeExtensions - name: StringHumanizeExtensions - type: Class - - uid: Humanizer.Tense - name: Tense - type: Enum - - uid: Humanizer.TimeOnlyToClockNotationExtensions - name: TimeOnlyToClockNotationExtensions - type: Class - - uid: Humanizer.TimeSpanHumanizeExtensions - name: TimeSpanHumanizeExtensions - type: Class - - uid: Humanizer.TimeUnit - name: TimeUnit - type: Enum - - uid: Humanizer.TimeUnitToSymbolExtensions - name: TimeUnitToSymbolExtensions - type: Class - - uid: Humanizer.To - name: To - type: Class - - uid: Humanizer.ToQuantityExtensions - name: ToQuantityExtensions - type: Class - - uid: Humanizer.TruncateExtensions - name: TruncateExtensions - type: Class - - uid: Humanizer.TruncateFrom - name: TruncateFrom - type: Enum - - uid: Humanizer.Truncator - name: Truncator - type: Class - - uid: Humanizer.TupleizeExtensions - name: TupleizeExtensions - type: Class - - uid: Humanizer.Vocabularies - name: Vocabularies - type: Class - - uid: Humanizer.Vocabulary - name: Vocabulary - type: Class - - uid: Humanizer.WordForm - name: WordForm - type: Enum - - uid: Humanizer.WordsToNumberExtension - name: WordsToNumberExtension - type: Class -memberLayout: SamePage diff --git a/docs/docfx.json b/docs/docfx.json index c3f577139..bbf74cf28 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -34,9 +34,6 @@ { "files": [ "api/**.yml" - ], - "exclude": [ - "api/toc.yml" ] } ],