Update documentation #144

docs/code/install/index.md

@@ -5,3 +5,27 @@
 - environment.yml
 - setup.py
 - pyproject.toml
+
+
+## Usage Examples
+
+`pip install oemetadata`
+
+
+```
+from metadata.latest.example import OEMETADATA_LATEST_EXAMPLE
+
+print(OEMETADATA_LATEST_EXAMPLE)
+```
+
+```
+from metadata.latest.schema import OEMETADATA_LATEST_SCHEMA
+
+print(OEMETADATA_LATEST_SCHEMA)
+```
+
+```
+from metadata.latest.template import OEMETADATA_LATEST_TEMPLATE
+
+print(OEMETADATA_LATEST_TEMPLATE)
+```

docs/development/release/index.md

@@ -4,3 +4,16 @@
 - VERSION
 - MANIFEST.in
 - .bumpversion.cfg
+
+
+## Release a new version
+See the complete instructions in the [RELEASE_PROCEDURE](./RELEASE_PROCEDURE.md).
+
+### Make PyPI release:
+
+First update version in setup.py, then:
+
+```
+python3 setup.py sdist bdist_wheel
+twine upload dist/*
+```

mkdocs.yml

@@ -39,15 +39,15 @@ theme:
 markdown_extensions:
   - admonition
   - toc:
-      permalink: 💙
+      permalink: "#"
 
 plugins:
 - mkdocstrings:
 
 # Customization
 extra:
   generator: false
-  homepage: https://openenergy-platform.org/
+  homepage: https://openenergyplatform.org/
 
 extra_css:
   - css/extra.css
@@ -73,9 +73,9 @@ nav:
   - Metadata Documentation:
       - metadata/index.md
       - Key Description: metadata/metadata_key_description.md
-#  - Code Documentation:
-#    - Install:
-#      - code/install/index.md
+  - Code Documentation:
+    - Install:
+      - code/install/index.md
 #    - Code Style:
 #      - code/style/index.md
 #    - Functions: