Skip to content

Commit da648ce

Browse files
committed
docs/README.md: add instructions for regenerating doxygen docs
1 parent 141b046 commit da648ce

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

docs/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
11
# Documentation
22

3-
* The `html` directory contains the programmatically generated
4-
[Doxygen docs](https://bxparks.github.io/AceTime/html/) which are viewable on
5-
GitHub Pages.
6-
* The other files are various subsections of the User Guide which are linked
7-
from the main [README.md](../README.md).
3+
The main [README.md](../README.md) and [USER_GUIDE.md](../USER_GUIDE.md)
4+
contain the majority of the documentation.
5+
6+
This directory contains scripts to generate [doxygen](https://www.doxygen.nl/)
7+
documentation from the embedded docstrings in the code.
8+
9+
First, install doxygen and GNU Make if you don't already have them, with
10+
something like the following on an Ubuntu Linux machine:
11+
12+
```
13+
$ sudo apt install doxygen make
14+
```
15+
16+
Second, run the `make` command to generate the HTML files under the `html`
17+
directory:
18+
19+
```
20+
$ cd docs
21+
$ make
22+
```
23+
24+
Third, open the `./docs/html/index.html` file in your web browser.

docs/doxygen.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = AceTime
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 3.0.0
41+
PROJECT_NUMBER = 4.0.0
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

0 commit comments

Comments
 (0)