site_name: Voxel Tools documentation
# TODO This should be changed to an environment variable
# This is fine for now, but when we have to support multiple versions of the documentation,
# the URL will vary, so in the long term we should not hardcode it here.
# This would be needed: https://github.com/readthedocs/readthedocs.org/issues/8260
site_url: https://voxel-tools.readthedocs.io/en/latest/
theme: readthedocs

docs_dir: source

extra_css:
  - css/extra.css

nav:
  - 'index.md'
  - 'getting_the_module.md'
  - 'quick_start.md'
  - 'overview.md'
  - 'terrain_types.md'
  - 'blocky_terrain.md'
  - 'smooth_terrain.md'
  - 'generators.md'
  - 'streams.md'
  - 'instancing.md'
  - 'editor.md'
  - 'multiplayer.md'
  - 'scripting.md'
  - 'performance.md'
  - 'module_development.md'
  - 'changelog.md'
  - '___.md'
  - 'API':
    # <generated_class_list>
    - api/FastNoiseLite.md
    - api/FastNoiseLiteGradient.md
    - api/Voxel.md
    - api/VoxelBlockSerializer.md
    - api/VoxelBoxMover.md
    - api/VoxelBuffer.md
    - api/VoxelColorPalette.md
    - api/VoxelGenerator.md
    - api/VoxelGeneratorFlat.md
    - api/VoxelGeneratorGraph.md
    - api/VoxelGeneratorHeightmap.md
    - api/VoxelGeneratorImage.md
    - api/VoxelGeneratorNoise.md
    - api/VoxelGeneratorNoise2D.md
    - api/VoxelGeneratorScript.md
    - api/VoxelGeneratorWaves.md
    - api/VoxelInstanceGenerator.md
    - api/VoxelInstanceLibrary.md
    - api/VoxelInstanceLibraryItem.md
    - api/VoxelInstanceLibraryItemBase.md
    - api/VoxelInstanceLibrarySceneItem.md
    - api/VoxelInstancer.md
    - api/VoxelLibrary.md
    - api/VoxelLodTerrain.md
    - api/VoxelMesher.md
    - api/VoxelMesherBlocky.md
    - api/VoxelMesherCubes.md
    - api/VoxelMesherDMC.md
    - api/VoxelMesherTransvoxel.md
    - api/VoxelNode.md
    - api/VoxelRaycastResult.md
    - api/VoxelServer.md
    - api/VoxelStream.md
    - api/VoxelStreamBlockFiles.md
    - api/VoxelStreamRegionFiles.md
    - api/VoxelStreamSQLite.md
    - api/VoxelStreamScript.md
    - api/VoxelTerrain.md
    - api/VoxelTool.md
    - api/VoxelToolBuffer.md
    - api/VoxelToolLodTerrain.md
    - api/VoxelToolTerrain.md
    - api/VoxelViewer.md
    - api/VoxelVoxLoader.md
    # </generated_class_list>
  - 'Serialization formats':
    - 'specs/block_format_v1.md'
    - 'specs/block_format_v2.md'
    - 'specs/instances_format.md'
    - 'specs/region_format_v2.md'
    - 'specs/region_format_v3.md'
    - 'specs/sqlite_format.md'
    - '___2.md'

markdown_extensions:
    # Makes permalinks appear on headings
    - toc:
        permalink: True
    # Makes boxes for notes and warnings
    - admonition
    # Better highlighter which supports GDScript
    - codehilite