-
-
Notifications
You must be signed in to change notification settings - Fork 330
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: move Programmer's manual creation to INSTALL.md (#4336)
- move Programmer's manual creation from `doc/development/README.md` to `INSTALL.md`. update `doc/development/README.md` - add Python API; add subsections - update URLs and wording - list guides - remove stray control chars (visible in vim) in `doc/development/style_guide.md`
- Loading branch information
Showing
3 changed files
with
44 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,19 @@ | ||
# 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. | ||
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. | ||
|
||
## How to generate the 'Programmer's Manual' | ||
## Style and GitHub guide | ||
|
||
You can locally generate the [GRASS GIS Programmer's Manual](https://grass.osgeo.org/programming8/). | ||
- [GRASS Programming Style Guide](style_guide.md) | ||
- [Guide to contributing on GitHub](github_guide.md) | ||
|
||
This needs doxygen (<http://www.doxygen.org>) and optionally | ||
Graphviz dot (<http://www.research.att.com/sw/tools/graphviz/>). | ||
## Python API | ||
|
||
To build the GRASS programmer's documentation, run | ||
- ["grass" Python package documentation](https://grass.osgeo.org/grass-devel/manuals/libpython/) | ||
|
||
```sh | ||
make htmldocs | ||
``` | ||
## C API | ||
|
||
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 | ||
``` | ||
- [GRASS Programmer's manual](https://grass.osgeo.org/programming8/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters