Add table of contents to docs

decompals · Jul 10, 2024 · 34566eb · 34566eb
1 parent 9d5807c
commit 34566eb
Show file tree

Hide file tree

Showing 4 changed files with 193 additions and 0 deletions.
diff --git a/docs/file_format/file.md b/docs/file_format/file.md
@@ -5,6 +5,36 @@ segment.
 
 Every attribute listed is optional unless explicitly stated.
 
+## Table of contents
+
+- [File](#file)
+  - [Table of contents](#table-of-contents)
+  - [`path`](#path)
+    - [Example](#example)
+    - [Valid values](#valid-values)
+  - [`kind`](#kind)
+    - [Example](#example-1)
+    - [Valid values](#valid-values-1)
+    - [Default value](#default-value)
+  - [`subfile`](#subfile)
+    - [Example](#example-2)
+    - [Valid values](#valid-values-2)
+    - [Default](#default)
+  - [`pad_amount`](#pad_amount)
+    - [Example](#example-3)
+    - [Valid values](#valid-values-3)
+  - [`section`](#section)
+    - [Valid values](#valid-values-4)
+  - [`linker_offset_name`](#linker_offset_name)
+    - [Valid values](#valid-values-5)
+  - [`section_order`](#section_order)
+    - [Example](#example-4)
+    - [Valid values](#valid-values-6)
+  - [`files`](#files)
+    - [Example](#example-5)
+  - [`dir`](#dir)
+    - [Example](#example-6)
+
 ## `path`
 
 Path to the file.

diff --git a/docs/file_format/segments.md b/docs/file_format/segments.md
@@ -9,6 +9,64 @@ the previous segment. This behavior can be changed with certain options.
 
 Every attribute listed is optional unless explicitly stated.
 
+## Table of contents
+
+- [Segments](#segments)
+  - [Table of contents](#table-of-contents)
+  - [`name`](#name)
+    - [Example](#example)
+    - [Valid values](#valid-values)
+  - [`files`](#files)
+    - [Example](#example-1)
+  - [`fixed_vram`](#fixed_vram)
+    - [Example](#example-2)
+    - [Valid values](#valid-values-1)
+    - [Default value](#default-value)
+  - [`fixed_symbol`](#fixed_symbol)
+    - [Example](#example-3)
+    - [Valid values](#valid-values-2)
+    - [Default value](#default-value-1)
+  - [`follows_segment`](#follows_segment)
+    - [Example](#example-4)
+    - [Valid values](#valid-values-3)
+    - [Default value](#default-value-2)
+  - [`vram_class`](#vram_class)
+    - [Example](#example-5)
+    - [Valid values](#valid-values-4)
+    - [Default value](#default-value-3)
+  - [`dir`](#dir)
+    - [Example](#example-6)
+    - [Valid values](#valid-values-5)
+    - [Default value](#default-value-4)
+  - [`alloc_sections`](#alloc_sections)
+    - [Example](#example-7)
+    - [Valid values](#valid-values-6)
+    - [Default value](#default-value-5)
+  - [`noload_sections`](#noload_sections)
+    - [Example](#example-8)
+    - [Valid values](#valid-values-7)
+    - [Default value](#default-value-6)
+  - [`subalign`](#subalign)
+    - [Example](#example-9)
+    - [Valid values](#valid-values-8)
+    - [Default value](#default-value-7)
+  - [`segment_start_align`](#segment_start_align)
+    - [Example](#example-10)
+    - [Valid values](#valid-values-9)
+    - [Default value](#default-value-8)
+  - [`section_end_align`](#section_end_align)
+    - [Example](#example-11)
+    - [Valid values](#valid-values-10)
+    - [Default value](#default-value-9)
+  - [`wildcard_sections`](#wildcard_sections)
+    - [Example](#example-12)
+    - [Valid values](#valid-values-11)
+    - [Default value](#default-value-10)
+  - [`fill_value`](#fill_value)
+    - [Example](#example-13)
+    - [Valid values](#valid-values-12)
+    - [Default value](#default-value-11)
+
 ## `name`
 
 This field is **required**.

diff --git a/docs/file_format/settings.md b/docs/file_format/settings.md
@@ -8,6 +8,94 @@ All the settings are optional. Unspecified options will use the default value
 for it. Note that using certain settings may require specifying other options
 as well.
 
+## Table of Contents
+
+- [Settings](#settings)
+  - [Table of Contents](#table-of-contents)
+  - [`base_path`](#base_path)
+    - [Example](#example)
+    - [Valid values](#valid-values)
+    - [Default value](#default-value)
+  - [`linker_symbols_style`](#linker_symbols_style)
+    - [Example](#example-1)
+    - [Valid values](#valid-values-1)
+    - [Default value](#default-value-1)
+  - [`hardcoded_gp_value`](#hardcoded_gp_value)
+    - [Example](#example-2)
+    - [Valid values](#valid-values-2)
+    - [Default value](#default-value-2)
+  - [`d_path`](#d_path)
+    - [Example](#example-3)
+    - [Valid values](#valid-values-3)
+  - [`target_path`](#target_path)
+    - [Example](#example-4)
+    - [Valid values](#valid-values-4)
+  - [`symbols_header_path`](#symbols_header_path)
+    - [Example](#example-5)
+    - [Valid values](#valid-values-5)
+  - [`symbols_header_type`](#symbols_header_type)
+    - [Example](#example-6)
+    - [Valid values](#valid-values-6)
+    - [Default value](#default-value-3)
+  - [`symbols_header_as_array`](#symbols_header_as_array)
+    - [Example](#example-7)
+    - [Valid values](#valid-values-7)
+    - [Default value](#default-value-4)
+  - [`sections_allowlist`](#sections_allowlist)
+    - [Example](#example-8)
+    - [Valid values](#valid-values-8)
+    - [Default value](#default-value-5)
+  - [`sections_allowlist_extra`](#sections_allowlist_extra)
+    - [Example](#example-9)
+    - [Valid values](#valid-values-9)
+    - [Default value](#default-value-6)
+  - [`sections_denylist`](#sections_denylist)
+    - [Example](#example-10)
+    - [Valid values](#valid-values-10)
+    - [Default value](#default-value-7)
+  - [`discard_wildcard_section`](#discard_wildcard_section)
+    - [Example](#example-11)
+    - [Valid values](#valid-values-11)
+    - [Default value](#default-value-8)
+  - [`single_segment_mode`](#single_segment_mode)
+    - [Example](#example-12)
+    - [Valid values](#valid-values-12)
+    - [Default value](#default-value-9)
+  - [`partial_scripts_folder`](#partial_scripts_folder)
+    - [Example](#example-13)
+    - [Valid values](#valid-values-13)
+  - [`partial_build_segments_folder`](#partial_build_segments_folder)
+    - [Example](#example-14)
+    - [Valid values](#valid-values-14)
+  - [`alloc_sections`](#alloc_sections)
+    - [Example](#example-15)
+    - [Valid values](#valid-values-15)
+    - [Default value](#default-value-10)
+  - [`noload_sections`](#noload_sections)
+    - [Example](#example-16)
+    - [Valid values](#valid-values-16)
+    - [Default value](#default-value-11)
+  - [`subalign`](#subalign)
+    - [Example](#example-17)
+    - [Valid values](#valid-values-17)
+    - [Default value](#default-value-12)
+  - [`segment_start_align`](#segment_start_align)
+    - [Example](#example-18)
+    - [Valid values](#valid-values-18)
+    - [Default value](#default-value-13)
+  - [`section_end_align`](#section_end_align)
+    - [Example](#example-19)
+    - [Valid values](#valid-values-19)
+    - [Default value](#default-value-14)
+  - [`wildcard_sections`](#wildcard_sections)
+    - [Example](#example-20)
+    - [Valid values](#valid-values-20)
+    - [Default value](#default-value-15)
+  - [`fill_value`](#fill_value)
+    - [Example](#example-21)
+    - [Valid values](#valid-values-21)
+    - [Default value](#default-value-16)
+
 ## `base_path`
 
 All the emitted paths are relative to this path. Useful when all the files are

diff --git a/docs/file_format/vram_classes.md b/docs/file_format/vram_classes.md
@@ -30,6 +30,23 @@ to how segments have linker symbols for their start, end and size. See
 - The size symbol is defined by the subtraction of the end and the start
   symbols.
 
+## Table of contents
+
+- [Vram classes](#vram-classes)
+  - [Table of contents](#table-of-contents)
+  - [`name`](#name)
+    - [Example](#example)
+    - [Valid values](#valid-values)
+  - [`fixed_vram`](#fixed_vram)
+    - [Example](#example-1)
+    - [Valid values](#valid-values-1)
+  - [`fixed_symbol`](#fixed_symbol)
+    - [Example](#example-2)
+    - [Valid values](#valid-values-2)
+  - [`follow_classes`](#follow_classes)
+    - [Example](#example-3)
+    - [Valid values](#valid-values-3)
+
 ## `name`
 
 This field is **required**.