Rename "docs" folder "source"
|
@ -1,9 +1,7 @@
|
||||||
site_name: Voxel Tools documentation
|
site_name: Voxel Tools documentation
|
||||||
theme: readthedocs
|
theme: readthedocs
|
||||||
|
|
||||||
# I had to specify this even though it's supposed to be the default
|
docs_dir: source
|
||||||
# See https://github.com/mkdocs/mkdocs/issues/2145#issuecomment-735342512
|
|
||||||
docs_dir: docs
|
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- 'index.md'
|
- 'index.md'
|
||||||
|
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 774 KiB After Width: | Height: | Size: 774 KiB |
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 101 KiB |
Before Width: | Height: | Size: 1.4 MiB After Width: | Height: | Size: 1.4 MiB |
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 154 KiB |
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
Before Width: | Height: | Size: 8.5 MiB After Width: | Height: | Size: 8.5 MiB |
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
Before Width: | Height: | Size: 804 KiB After Width: | Height: | Size: 804 KiB |
Before Width: | Height: | Size: 1.1 MiB After Width: | Height: | Size: 1.1 MiB |
Before Width: | Height: | Size: 944 KiB After Width: | Height: | Size: 944 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 122 KiB After Width: | Height: | Size: 122 KiB |
Before Width: | Height: | Size: 279 KiB After Width: | Height: | Size: 279 KiB |
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 130 KiB After Width: | Height: | Size: 130 KiB |
|
@ -15,3 +15,4 @@ Explore categories on the left to get started!
|
||||||
![Editor screenshot](images/graph_in_editor_with_fast_noise_lite.png)
|
![Editor screenshot](images/graph_in_editor_with_fast_noise_lite.png)
|
||||||
|
|
||||||
![Smooth screenshot](images/smooth_screenshot.png)
|
![Smooth screenshot](images/smooth_screenshot.png)
|
||||||
|
|
|
@ -22,6 +22,8 @@ import glob
|
||||||
import os
|
import os
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
|
SOURCES = "docs"
|
||||||
|
|
||||||
|
|
||||||
def update_classes_xml(custom_godot_path, godot_repo_root, verbose=False):
|
def update_classes_xml(custom_godot_path, godot_repo_root, verbose=False):
|
||||||
godot_executable = custom_godot_path
|
godot_executable = custom_godot_path
|
||||||
|
@ -80,11 +82,10 @@ def find_godot(bindir):
|
||||||
def update_mkdocs_file(mkdocs_config_fpath, md_classes_dir):
|
def update_mkdocs_file(mkdocs_config_fpath, md_classes_dir):
|
||||||
absolute_paths = md_classes_dir.glob("*.md")
|
absolute_paths = md_classes_dir.glob("*.md")
|
||||||
class_files = []
|
class_files = []
|
||||||
docs_folder = mkdocs_config_fpath.parents[0] / 'docs'
|
docs_folder = mkdocs_config_fpath.parents[0] / SOURCES
|
||||||
for absolute_path in absolute_paths:
|
for absolute_path in absolute_paths:
|
||||||
class_files.append(str(absolute_path.relative_to(docs_folder)).replace('\\', '/'))
|
class_files.append(str(absolute_path.relative_to(docs_folder)).replace('\\', '/'))
|
||||||
class_files = sorted(class_files)
|
class_files = sorted(class_files)
|
||||||
class_files = list(sorted(class_files))
|
|
||||||
|
|
||||||
with open(mkdocs_config_fpath, 'r', encoding='utf-8') as f:
|
with open(mkdocs_config_fpath, 'r', encoding='utf-8') as f:
|
||||||
lines = f.readlines()
|
lines = f.readlines()
|
||||||
|
@ -137,7 +138,7 @@ def main():
|
||||||
godot_executable = ""
|
godot_executable = ""
|
||||||
|
|
||||||
godot_repo_root = my_path.parents[4]
|
godot_repo_root = my_path.parents[4]
|
||||||
md_path = my_path.parents[1] / 'docs/api'
|
md_path = my_path.parents[1] / SOURCES / 'api'
|
||||||
xml_path = my_path.parents[1] / 'classes'
|
xml_path = my_path.parents[1] / 'classes'
|
||||||
mkdocs_config_path = my_path.parents[1] / 'mkdocs.yml'
|
mkdocs_config_path = my_path.parents[1] / 'mkdocs.yml'
|
||||||
|
|
||||||
|
|