Commit 865ba2a7 authored by Paal Kvamme's avatar Paal Kvamme
Browse files

Documentation update. Note where the latest version can be found.

parent 1c5e21ed
Pipeline #29747 passed with stages
in 10 minutes and 1 second
This folder contains a snapshot of the OpenZGY documentation, but only as pdf files and only for the public api. It might not be completely up to date.
The latest version of the OpenZGY documentation is built by Doxygen and is available after the project has been built. If you are building the software yourself then you will find the documentation in build/deploy/native.
If you don't want to build yourself then you can fetch the documentation from the CI/CD pipeline in gitlab as follows.
* Open the [OpenZGY project page in OSDU](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/open-zgy)
* Go to CI/CD -> Pipelines
* Select the latest good build on master and click on the "passed" box.
* Click on the doc-compile box
* Click "Browse"
* Navigate to build/deploy/native or build/deploy/pure
* Download the documentation you want.
apidoc has the public api only. intdoc also includes implementation.
The pdf version is good for a quick look and you can read it directly on the web. The html version is much better organized and has good search capabilities but you need to download and unpack it before viewing it locally. The OSDU web server cannot serve these pages directly. It can only serve single page documents.
At some point the documentation built on gitlab might be deployed to a proper web server that allows the html version to be displayed online.
......@@ -54,6 +54,11 @@ namespace OpenZGY {
* \li ProgressWithDots example of progress reporting.
* \li \ref Example Example application.
*
* If you are reading this document from doxygen/native/apidoc.pdf
* in the source tree then please see doxygen/README.md for an
* explanation of why the documentation produced by the build might
* be better.
*
* \if IMPL
* If you are viewing the full Doxygen documentation then this
* covers both the API and most of the implementation. So if you
......
......@@ -56,6 +56,11 @@ those tests that compare the old and new behavior.
# \li ProgressWithDots example of progress reporting.
# \li \ref Example Example application.
#
# If you are reading this document from doxygen/pure/apidoc.pdf
# in the source tree then please see doxygen/README.md for an
# explanation of why the documentation produced by the build might
# be better.
#
# \if IMPL
# If you are viewing the full Doxygen documentation then this
# covers both the API and most of the implementation. So if you
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment