Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ CMakeUserPresets.json
/python/*.dylib
/python/wheelhouse
/python/hyperon/_version.py
/docs/generated/*.md
/site
1 change: 1 addition & 0 deletions docs/building_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Empty file added docs/generated/.placeholder
Empty file.
4 changes: 2 additions & 2 deletions mkdocs.metta
Original file line number Diff line number Diff line change
Expand Up @@ -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)
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading