Skip to content

Commit ee875b7

Browse files
committed
[MOREL-269] Decompose the documentation for built-in functions and structures
The reference contains a table (in Markdown format) of all built-in functions. This change moves the metadata in that table to a few file, functions.toml, adds a test to generate that section of the reference from the metadata and check that it is the same. In the future, functions will be added to the metadata first, and we will generate more things from the metadata. The table will also allow us to generate finer-grained documentation, maybe one page for each structure or function. Obsolete `class TestUtil`, moving methods to `TestUtils`. Add `Bool.op implies` to function table. Fixes #269
1 parent 000b878 commit ee875b7

File tree

9 files changed

+3415
-108
lines changed

9 files changed

+3415
-108
lines changed

docs/howto.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Make sure `mvn clean install`, `mvn site`, and
2727

2828
Upgrade dependencies to their latest release: run
2929
```bash
30+
./mvnw versions:display-dependency-updates
3031
./mvnw versions:update-properties
3132
```
3233
and commit the modified `pom.xml`.

docs/reference.md

Lines changed: 40 additions & 38 deletions
Large diffs are not rendered by default.

pom.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ License.
9797
<javacc-maven-plugin.version>3.0.3</javacc-maven-plugin.version>
9898
<javacc.version>7.0.13</javacc.version>
9999
<jline.version>3.25.0</jline.version>
100+
<jackson.version>2.19.0</jackson.version>
100101
<junit-jupiter.version>5.12.2</junit-jupiter.version>
101102
<maven-checkstyle-plugin.version>3.6.0</maven-checkstyle-plugin.version>
102103
<maven-compiler-plugin.version>3.14.0</maven-compiler-plugin.version>
@@ -139,6 +140,12 @@ License.
139140
</scm>
140141

141142
<dependencies>
143+
<dependency>
144+
<groupId>com.fasterxml.jackson.dataformat</groupId>
145+
<artifactId>jackson-dataformat-toml</artifactId>
146+
<version>${jackson.version}</version>
147+
<scope>test</scope>
148+
</dependency>
142149
<dependency>
143150
<groupId>com.google.code.findbugs</groupId>
144151
<artifactId>jsr305</artifactId>

0 commit comments

Comments
 (0)