Update documentation and README.md

sarahshi · Dec 7, 2023 · ae45b39 · ae45b39
1 parent 577ecbe
commit ae45b39
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # mineralML
-<!-- [![PyPI](https://badgen.net/pypi/v/mineralML)](https://pypi.org/project/mineralML/) -->
+[![PyPI](https://badgen.net/pypi/v/mineralML)](https://pypi.org/project/mineralML/)
 [![Build Status](https://github.com/SarahShi/mineralML/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/SarahShi/mineralML/actions/workflows/main.yml)
 [![Documentation Status](https://readthedocs.org/projects/mineralml/badge/?version=latest)](https://mineralml.readthedocs.io/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/SarahShi/mineralML/branch/main/graph/badge.svg)](https://codecov.io/gh/SarahShi/mineralML/branch/main)

diff --git a/docs/_static/mineralML_logo.png b/docs/_static/mineralML_logo.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -151,11 +151,11 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-# html_logo = "_static/mineralML_logo.png"
-# html_theme_options = {
-#     'logo_only': True,
-#     'display_version': False,
-# }
+html_logo = "_static/mineralML_logo.png"
+html_theme_options = {
+    'logo_only': True,
+    'display_version': False,
+}
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

diff --git a/docs/importing_data.rst b/docs/importing_data.rst
@@ -27,14 +27,14 @@ The following columns are required for this Chemistry file:
 *  Sample
 *  SiO\ :sub:`2`
 *  TiO\ :sub:`2`
-*  Al\ :sub:`2`O\ :sub:`3`
+*  Al\ :sub:`2` O\ :sub:`3`
 *  FeO\ :sub:`t`
 *  MnO
 *  MgO 
 *  CaO 
-*  Na\ :sub:`2`O
-*  K\ :sub:`2`O
-*  Cr\ :sub:`2`O\ :sub:`3`
+*  Na\ :sub:`2` O
+*  K\ :sub:`2` O
+*  Cr\ :sub:`2` O\ :sub:`3`
 
 For example, here a screenshot of a CSV spreadsheet containing the mineral composition data. You can use the ChemistryTemplate.csv from the GitHub repository to create your own. For oxides that were not analyzed or not detected, enter 0 into the cell. 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,7 @@
 Welcome to mineralML's documentation!
 ======================================
 
+.. image:: _static/mineralML_logo.png
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -55,14 +55,14 @@ Chemistry
 
 *  SiO\ :sub:`2`
 *  TiO\ :sub:`2`
-*  Al\ :sub:`2`O\ :sub:`3`
+*  Al\ :sub:`2` O\ :sub:`3`
 *  FeO\ :sub:`t`
 *  MnO
 *  MgO 
 *  CaO 
-*  Na\ :sub:`2`O
-*  K\ :sub:`2`O
-*  Cr\ :sub:`2`O\ :sub:`3`
+*  Na\ :sub:`2` O
+*  K\ :sub:`2` O
+*  Cr\ :sub:`2` O\ :sub:`3`
 
 
 =====