Minor tweaks to documentation

Author: pgleeson

docs/sphinx/source/api/Installation.md

@@ -2,7 +2,7 @@
 
 ## Requirements
 
-Python >=3.7 is required. Support on Python 3.11 is limited.
+Python >=3.7 is required. Support on Python 3.11 is limited (see [here](https://github.com/ModECI/modelspec/issues/25)).
 
 ## Installation using pip
 

docs/sphinx/source/api/Quickstart.md

@@ -15,18 +15,18 @@ More details, and importantly, how to set up a [virtual environment](https://vir
 
 ### Simple example
 
-A basic example which illustrates how to create the specification for a document(model) and create serialized instances can be found [here](examples/README)
+A basic example which illustrates how to create the specification for a document(model) and create serialized instances can be found [here](examples/README).
 
 ### Serialization formats
 
-Python scripts can be used to generate the specification of a type of model(e.g. [this](https://github.com/ModECI/modelspec/blob/main/examples/document.py)), but the models are saved in standardized format in either text based [JSON](https://github.com/ModECI/modelspec/blob/main/examples/document.json) or [YAML](https://github.com/ModECI/modelspec/blob/main/examples/document.yaml) formats or in binary [BSON](https://github.com/ModECI/modelspec/blob/main/examples/document.bson) format.
+Python scripts can be used to generate the specification of a type of model(e.g. [this](https://github.com/ModECI/modelspec/blob/main/examples/document.py)), but the models are saved in standardized format in either text based [JSON](https://github.com/ModECI/modelspec/blob/main/examples/document.json) or [YAML](https://github.com/ModECI/modelspec/blob/main/examples/document.yaml) formats or in binary [BSON](https://github.com/ModECI/modelspec/blob/main/examples/document.bson) format. Support for XML serialization is under development.
 
-### Currently supported environments
+### Current formats using modelspec
 
 #### MDF
 
-Mdf uses modelspec to create the structure of its models and convert the models into serialize formats such as json, yaml, and bson.
+MDF uses modelspec to create the structure of its models and convert the models into serialized formats such as JSON, YAML, and BSON.
 
 #### NeuroML
 
-NeuroMLite uses modelspec to create the structure of its models and convert the models into serialize formats such as json, yaml, and bson.
+NeuroMLlite uses modelspec to create the structure of its models and convert the models into serialize formats such as JSON, YAML, and BSON.

docs/sphinx/source/api/examples/document.specification.bson

@@ -11,7 +11,7 @@ Welcome to Modelspec's documentation
 Modelspec is an open source, community-supported standard library used for specifying the structure of models
 and enabling automatic serialization.
 It is still in development and it is being used by
-`MDF <https://github.com/ModECI/MDF>`_ and `NeuroMLite <https://github.com/NeuroML/NeuroMLlite>`_.
+`MDF <https://github.com/ModECI/MDF>`_ and `NeuroMLlite <https://github.com/NeuroML/NeuroMLlite>`_.
 
 .. toctree::
    :maxdepth: 1

docs/sphinx/source/index.rst

@@ -1,19 +1,40 @@
 #!/bin/bash
 set -ex
 
+## Install
+
 pip install .
 
+
+## Test main example
+
 cd examples
 python document.py
 
 cd test
 python test.py
 
+
+## Test NeuroML example
+
 cd ../neuroml2
 python neuroml2_spec.py
 
 cd ../..
 
+
+## Run pytest
+
 pytest tests -v
 
+
+## Generate the docs
+
+cd docs
+python generate.py
+cd sphinx
+make clean
+make html
+cd ..
+
 pre-commit run --all-files