-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added some skeletal documentation config
- Loading branch information
1 parent
35e47bb
commit cfe46fb
Showing
5 changed files
with
598 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"proseWrap": "always" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Oops, something went wrong.