Set up library user documentation

GNS-Science / solvis

NSHM opensha inversion solution analysis python module

GNU Affero General Public License v3.0

1 stars 1 forks source link

Set up library user documentation #34

Closed DrCuriosity closed 4 months ago

DrCuriosity commented 4 months ago

For: #29

In this PR:

Setup for MkDocs, mkdocstrings
General documentation structure
Functional documentation (mostly in geometry so far; may need scientific sense-checking)

Still a good number of TODOs, and inversion solution-related functions that could use proper documentation, but it's coming along.

One I was hoping for help with was a clearer definition for the solvis.geometry.section_distance function.

chrisdicaprio commented 4 months ago

might look into if it's possible to set universal options on the module docs so that we don't have to repeat

    options:
        filters: ["!^_"]

In every file

chrisdicaprio commented 4 months ago

README.md should have a link to https://opensha.org/ and https://opensha.org/Modular-Fault-System-Solution

DrCuriosity commented 4 months ago

might look into if it's possible to set universal options on the module docs so that we don't have to repeat
    options:
        filters: ["!^_"]
In every file

Sure. I was largely cargo-culting from Common there to get something built out quickly, but I'm fairly certain we set up some default filters in the mkdocstrings Python handler config.