Add basic docs.

materialsvirtuallab · Nov 4, 2023 · 9f51281 · 9f51281
1 parent f9c7ccd
commit 9f51281
Show file tree

Hide file tree

Showing 8 changed files with 1,233 additions and 0 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,30 @@
+title: matcalc
+email: [email protected]
+description: >- # this means to ignore newlines until "baseurl:"
+  MatCalc is a Python library for calculating materials properties from the potential energy surface (PES).
+baseurl: ""
+# twitter_username: matcalc
+github_username: materialsvirtuallab
+
+# Build settings
+remote_theme: just-the-docs/just-the-docs
+
+color_scheme: pmg
+favicon_ico: /assets/favicon.ico
+
+aux_links:
+  API docs: /matcalc
+  GitHub: https://github.com/materialsvirtuallab/matcalc
+  Issues: https://github.com/materialsvirtuallab/matcalc/issues
+  Materials Virtual Lab: https://materialsvirtuallab.org
+
+# Enable or disable the site search
+# Supports true (default) or false
+search_enabled: true
+
+# Split pages into sections that can be searched individually
+# Supports 1 - 6, default: 2
+search.heading_level: 6
+
+kramdown:
+  toc_levels: 1..3
diff --git a/docs/assets b/docs/assets
diff --git a/docs/changes.md b/docs/changes.md
@@ -0,0 +1,9 @@
+# Change Log
+
+## v0.0.2
+
+- Minor updates to returned dicts.
+
+## v0.0.1
+
+- First release with all major components.