Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move Programmer's manual creation to INSTALL.md #4336

Merged
merged 5 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
39 changes: 36 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,42 @@ developers mailing list. See <https://grass.osgeo.org/development/>

## (L) GRASS PROGRAMMER'S MANUAL

The Programmer's manual is generated with doxygen from the source code.
Please see the [README](doc/development/README.md) file and the files at:
<https://grass.osgeo.org/programming8/>
The Programmer's manual <https://grass.osgeo.org/programming8/> is
generated from the source code. This requires the installation of
`doxygen` (<http://www.doxygen.nl>) and optionally Graphviz `dot`
(<https://graphviz.org/doc/info/command.html>).

To locally generate the 'Programmer's Manual', run

```sh
make htmldocs
```

To generate documentation as a single html file
(recommended for simple reading)

```sh
make htmldocs-single
```

This process takes some time. The result will be found in
the file `lib/html/index.html` which itself refers to further
document repositories in

```text
lib/vector/html/index.html
lib/db/html/index.html
lib/gis/html/index.html
```
neteler marked this conversation as resolved.
Show resolved Hide resolved

The master file is: `./grasslib.dox` where all sub-documents have to
neteler marked this conversation as resolved.
Show resolved Hide resolved
be linked to.

To generate the 'Programmer's Manual' in PDF format, run

```sh
make pdfdocs
```

## (M) CONTRIBUTING CODE AND PATCHES

Expand Down
49 changes: 8 additions & 41 deletions doc/development/README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,10 @@
# Development and Maintenance Documentation

Here is development and maitanance documentation. The API documentation
is at appropriate places, but here is the information relevant to
contributing to GRASS GIS and its maintanance.

## How to generate the 'Programmer's Manual'

You can locally generate the [GRASS GIS Programmer's Manual](https://grass.osgeo.org/programming8/).

This needs doxygen (<http://www.doxygen.org>) and optionally
Graphviz dot (<http://www.research.att.com/sw/tools/graphviz/>).

To build the GRASS programmer's documentation, run

```sh
make htmldocs
```

Or to generate documentation as a single html file
(recommended for simple reading)

```sh
make htmldocs-single
```

This takes quite some time. The result is in `lib/html/index.html`
which refers to further document repositories in

```text
lib/vector/html/index.html
lib/db/html/index.html
lib/gis/html/index.html
```

The master file is: `./grasslib.dox` where all sub-documents have to
be linked to.

To generate the documents in PDF format, run

```sh
make pdfdocs
```
Find below the development and maintenance documentation.
The API documentation is available in the appropriate places,
but here is the information relevant to contributing to and
maintaining GRASS GIS.

- [GRASS Programming Style Guide](./doc/development/style_guide.md)
- [Guide to contributing on GitHub](./doc/development/github_guide.md)
- [GRASS Programmer's manual](https://grass.osgeo.org/programming8/)
neteler marked this conversation as resolved.
Show resolved Hide resolved
neteler marked this conversation as resolved.
Show resolved Hide resolved
Loading