Skip to content

Commit 7e9f21e

Browse files
author
Mark R. Tuttle
committed
Correct and elaborate the documentation-build documentation
1 parent 947d3f3 commit 7e9f21e

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

doc/doxygen-root/README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,52 @@
22

33
This is the root of CBMC documentation.
44

5-
## Install doxygen
5+
## Install tools
66

7-
Building this documentation requires `doxygen` and `graphviz`.
7+
Building this documentation requires `doxygen`, `graphviz`, and `pandoc`.
88

99
* On MacOS,
1010
we recommend installing with [brew](https://brew.sh/):
1111
```
12-
brew install doxygen graphviz
12+
brew install doxygen graphviz pandoc
1313
```
1414
* On Ubuntu, we recommend installing with using `apt`:
1515
```
16-
sudo apt install doxygen graphviz
16+
sudo apt install doxygen graphviz pandoc
1717
```
1818

19-
Note: As of
20-
2119
## Build the documentation
2220

2321
To build the documentation, run
2422

2523
```
26-
doxygen
24+
make
2725
```
2826

29-
The documentation takes about five minutes to build and is written to
30-
the `html` subdirectory as a set of 2600+ html files. To view the
31-
documentation,
27+
The build takes about five minutes, and the documentation is written to
28+
the `html` subdirectory as a mostly-flat collection of 2600+ html files.
29+
To view the documentation,
3230
open the file `html/index.html` in a web browser. One MacOS, run
3331

3432
```
3533
open html/index.html
3634
```
3735

36+
The build will refuse to run if the repository is dirty
37+
(if there are uncomitted changes).
38+
The build appends "last modified" tags to the end of every markdown file,
39+
which modifies about 60 markdown files.
40+
Run `git checkout .` in the repository root to restore the markdown files
41+
to their original state.
42+
43+
The build actually runs six builds:
44+
45+
* the legacy CPROVER documentation in `src` and `doc` which now includes the
46+
top-level pages in this directory,
47+
* the legacy CPROVER manual in `doc/cprover-manual`,
48+
* the man pages in `doc/man`, and
49+
* some supplemental documentation in `doc/API`, `doc/ADR`, and `doc/assets`.
50+
3851
## Publish the documentation
3952

4053
To publish the documentation, we use the GitHub workflow
@@ -44,7 +57,11 @@ the `github.io` web site.
4457

4558
## Contribute documentation
4659

47-
Coming soon...
60+
To contribute to this documentation,
61+
there are some [documentation instructions](contributing.md) written
62+
to make it easier for you to link your documentation into the right
63+
location.
64+
4865

4966
## References
5067

0 commit comments

Comments
 (0)