diff --git a/.gitignore b/.gitignore index c16920e41..10ae1b9cd 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,5 @@ CMakeUserPresets.json /python/*.dylib /python/wheelhouse /python/hyperon/_version.py +/docs/generated/*.md +/site diff --git a/docs/building_docs.md b/docs/building_docs.md index 867644ec2..41815817b 100644 --- a/docs/building_docs.md +++ b/docs/building_docs.md @@ -31,6 +31,7 @@ Run the following command under the root directory of the repository: ``` cargo run --release --bin metta-repl ./mkdocs.metta ``` +Docs can be found at `./doc/generated/*.md`. ## Building Python Documentation diff --git a/docs/generated/.placeholder b/docs/generated/.placeholder new file mode 100644 index 000000000..e69de29bb diff --git a/mkdocs.metta b/mkdocs.metta index 89178b608..86238bb1e 100644 --- a/mkdocs.metta +++ b/mkdocs.metta @@ -48,13 +48,13 @@ (let $sorted (sort-strings $helps) (let $text (foldl-atom $sorted "" $r $i (format-args "{}{}" ($r $i))) (let $md (format-args "# {}\n{}" ($title $text)) - (let $path (format-args "./docs/{}.md" ($mod)) + (let $path (format-args "./docs/generated/{}.md" ($mod)) (let $file (file-open! $path "wct") (file-write! $file $md) )))))))) !(document-module "Standard library" corelib) +!(document-module "Random" random) !(document-module "File Input/Output" fileio) !(document-module "JSON" json) -!(document-module "Random" random) !(document-module "Module catalog" catalog) ;!(document-module "DAS" das) diff --git a/mkdocs.yml b/mkdocs.yml index 22a2daef1..05c1ffb75 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -134,11 +134,11 @@ nav: - Home: index.md - MeTTa specification: metta.md - MeTTa API Reference: - - Standard library: corelib.md - - Random: random.md - - File I/O: fileio.md - - JSON: json.md - - Module catalogs: catalog.md + - Standard library: generated/corelib.md + - Random: generated/random.md + - File I/O: generated/fileio.md + - JSON: generated/json.md + - Module catalogs: generated/catalog.md - Minimal Metta specification: minimal-metta.md - MeTTa modules: modules_dev.md - DAS setup: das_setup.md