Browse Source

docs: cleanup conf // phrasing and references

priors
miili 2 years ago
parent
commit
34ba7234f0
3 changed files with 8 additions and 3 deletions
  1. +0
    -1
      docs/source/conf.py
  2. +6
    -0
      docs/source/overview/index.rst
  3. +2
    -2
      docs/source/report/index.rst

+ 0
- 1
docs/source/conf.py View File

@ -133,7 +133,6 @@ html_title = u"%s Manual (v%s)" % (project, release)
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = []


+ 6
- 0
docs/source/overview/index.rst View File

@ -36,6 +36,10 @@ To use Grond with your own dataset, we suggest the following folder structure.
Single files and data formats listed here are explained below. The folders ``runs`` and ``report`` are generated during and after the optimisation, respectively.
.. tip ::
Use ``grond init <example> <project_folder>`` to create an example project following this layout! See :ref:`project-init` for more information.
.. code-block :: none
├── config
@ -188,6 +192,8 @@ certain targets:
Consult :option:`grond init` ``--help`` for your options. The different ``targets`` (data and misfit setups for seismic waveforms, InSAR and or GNSS data) can be combined and source model types can be exchanged.
.. _project-scenario:
Initializing a scenario project from forward modelling
......................................................


+ 2
- 2
docs/source/report/index.rst View File

@ -65,8 +65,8 @@ under a link on the report web page. After unpacking, place the archive file
into the unpacked directory to keep the archive file link operational.
Plot types
----------
Available plots
---------------
To see which plots are available for a particular configuration, check out the
subcommand


Loading…
Cancel
Save