search

gem / oq-engine

OpenQuake Engine: a software for Seismic Hazard and Risk Analysis
https://github.com/gem/oq-engine/#openquake-engine
GNU Affero General Public License v3.0
377 stars 273 forks source link

Include an HTML version of the manual in the engine distribution #4676

Closed micheles closed 2 years ago

micheles commented 5 years ago

We could also include the engine APi documentation (i.e. https://docs.openquake.org/oq-engine/master/) and the advanced manual (i..e https://docs.openquake.org/oq-engine/advanced/). The WebUI could contains links to such documentation.

The big issue is the engine manual, which is in latex. We will have to convert it into sphinx. We will need to investigate how to keep the bibliography and the glossary. We will also need to convince @mmpagani (all the others are already convinced).

micheles commented 5 years ago

I have discovered that the glossary has been broken (i.e. empty) since right after release 3.1 :-(

raoanirudh commented 3 years ago

I have discovered that the glossary has been broken (i.e. empty) since right after release 3.1 :-(

Glossary fixed in #6124

CatalinaYepes commented 3 years ago

Any plan for moving this issue forward?

An HTML of the manual will be much more searchable for users. For example, pages from the advance users manual appear in search engines, but no reference is provided to the basic manual. In addition, this could reduce the number of questions in the user forum related to basic input parameters.

We should also consider moving to HTML format the OQ hazard and risk books

micheles commented 3 years ago

It is a huge work and we still need to convince Marco. Likely it will never be done.