Skip to content

Commit

Permalink
Added some skeletal documentation config
Browse files Browse the repository at this point in the history
  • Loading branch information
davenquinn committed Jan 3, 2024
1 parent 35e47bb commit cfe46fb
Show file tree
Hide file tree
Showing 5 changed files with 598 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"proseWrap": "always"
}
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Macrostrat Python libraries

Welcome to the documentation for the Macrostrat monorepo! This repository
contains various Python libraries developed by the Macrostrat team. These
libraries are designed to provide functionality that can be used across
geoscience software products and applications.

## Libraries

- [`macrostrat.app-frame`](app-frame): A skeleton to scaffold application
control scripts
- [`macrostrat.database`](database): Tools to maintain "database-driven"
applications, especially PostgreSQL and PostGIS
- [`macrostrat.dinosaur`](dinosaur): A library for database schema evolution
- [`macrostrat.utils`](utils): A collection of utility functions
- [`macrostrat.package-tools`](package-tools): Tools for managing Python
packages
15 changes: 15 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
site_name: Macrostrat Python libraries
theme:
name: "material"
nav:
- Home: "index.md"
- Macrostrat:
- App Frame: "macrostrat/app_frame.md"
- Database: "macrostrat/database.md"
- Dinosaur: "macrostrat/dinosaur.md"
- Package Tools: "macrostrat/package_tools.md"
- Utils: "macrostrat/utils.md"

plugins:
- search
- mkdocstrings
Loading

0 comments on commit cfe46fb

Please sign in to comment.