Doc updates (#21)

Fixed:
- typos in quickstart doc
- disabled deployment to repository until authentication issue is fixed.

Author: neelgala

.travis.yml

@@ -12,16 +12,16 @@ script:
   - cd ../
   - if [ "$TRAVIS_BRANCH" = "master" ]; then python setup.py sdist; fi
   - if [ "$TRAVIS_BRANCH" = "master" ]; then python -m twine upload --username $pypiusername --password $pypipassword dist/*; fi
-before_deploy:
-  - git tag $TAGNAME
-deploy:
-  provider: releases
-  api_key:
-    secure: $github_access_token
-  file_glob: true
-  file: docs/build/latex/*.pdf
-  skip_cleanup: true
-  on:
-    repo: riscv/riscv-config
-    branch: master
-    tags: false
+    #before_deploy:
+    #  - git tag $TAGNAME
+    #deploy:
+    #  provider: releases
+    #  api_key:
+    #    secure: $github_access_token
+    #  file_glob: true
+    #  file: docs/build/latex/*.pdf
+    #  skip_cleanup: true
+    #  on:
+    #    repo: riscv/riscv-config
+    #    branch: master
+    #    tags: false

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.0.1 - 2020-03-25
+### Fixed
+- typos in quickstart doc
+- disabled deployment to repository until authentication issue is fixed.
+
 ## 2.0.0 - 2020-03-25
 ### Added
 - adding support for warl fields and support

README.rst

@@ -5,7 +5,4 @@ RISC-V Configuration Validator
 
 LICENSE: BSD-3 Clause.
 
-Latest Documentation of RISCV-Config:
-
-  * `HTML <https://riscv-config.readthedocs.io/>`_
-  * `PDF  <https://github.com/riscv/riscv-config/releases/latest/download/riscv_config.pdf>`_
+Latest Documentation of RISCV-Config: `HTML <https://riscv-config.readthedocs.io/>`_

docs/source/conf.py

@@ -27,6 +27,11 @@ def gen_schema_doc(infile, outfile):
 
     rst_file.close()
 
+def get_version():
+    changelog = open('../../CHANGELOG.md','r').read()
+    x = re.findall(r'##(.*?)-',changelog)[0]
+    return str(x)
+
 gen_schema_doc('../../riscv_config/schemas/schema_isa.yaml', 'schema_isa.rst')
 gen_schema_doc('../../riscv_config/schemas/schema_platform.yaml', 'schema_platform.rst')
 
@@ -40,10 +45,9 @@ def gen_schema_doc(infile, outfile):
 copyright = '2019 InCore Semiconductors, IIT Madras'
 author = 'InCore Semiconductors Pvt. Ltd.'
 
-# The short X.Y version
-version = '1.2.0'
+version = str(get_version())
 # The full version, including alpha/beta/rc tags
-release = 'beta'
+release = version
 
 
 # -- General configuration ---------------------------------------------------

docs/source/quickstart.rst

@@ -2,13 +2,13 @@
 Quickstart
 ##########
 
-This doc is meant to serve as a quick-guide to setup RISCOF and perform a sample compliance check
-between ``spike`` (DUT in this case) and ``riscvOVPsim`` (Golden model in this case).
+This doc is meant to serve as a quick-guide to setup RISCV-CONFIG and perform a \
+sample validation of target specifications.
 
 Install Python Dependencies
 ===========================
 
-RISCOF requires `pip` and `python` (>=3.7) to be available on your system. If you have issues, instead of
+RISCV-CONFIG requires `pip` and `python` (>=3.7) to be available on your system. If you have issues
 installing either of these directly on your system, we suggest using a virtual environment
 like `pyenv` to make things easy.
 
@@ -42,15 +42,15 @@ Open a new terminal and create a virtual environment using the following
 .. code-block:: bash
 
   $ pyenv install 3.7.0
-  $ pyenv virtualenv 3.7.0 riscof_env
+  $ pyenv virtualenv 3.7.0 riscv_config_env
 
 
 Now you can activate this virtual environment using the following command:
 
 .. code-block:: bash
 
-  $ pyenv activate riscof_env
-  $ python ==version
+  $ pyenv activate riscv_config_env
+  $ python --version
 
 Install via PIP [users]
 =======================
@@ -62,33 +62,33 @@ performing the following steps.
 
   $ pip install riscv_config
 
-To update an already installed version of RISCOF to the latest version:
+To update an already installed version of RISCV-CONFIG to the latest version:
 
 .. code-block:: bash
 
   $ pip install -U riscv_config
 
-To checkout a specific version of riscof:
+To checkout a specific version of riscv_config:
 
 .. code-block:: bash
 
-  $ pip install riscv_config==1.x.x
+  $ pip install riscv_config--1.x.x
 
-Once you have RISCV_CONFIG installed, executing ``riscv_config ==help`` should print the following on the terminal:
+Once you have RISCV_CONFIG installed, executing ``riscv_config --help`` should print the following on the terminal:
 
 .. code-block:: bash
 
-    riscv-config [-h] ==isa_spec YAML ==platform_spec YAML [==verbose]
+    riscv-config [-h] --isa_spec YAML --platform_spec YAML [--verbose]
 
     RISC-V Configuration Validator 
     
     optional arguments:
-      ==isa_spec YAML, -ispec YAML
+      --isa_spec YAML, -ispec YAML
                             The YAML which contains the ISA specs.
-      ==platform_spec YAML, -pspec YAML
+      --platform_spec YAML, -pspec YAML
                             The YAML which contains the Platfrorm specs.
-      ==verbose             debug | info | warning | error
-      -h, ==help            show this help message and exit
+      --verbose             debug | info | warning | error
+      -h, --help            show this help message and exit
 
 
 
@@ -105,7 +105,7 @@ performing the following steps.
   $ cd riscv_config
   $ pip3 install -r requirements.txt
 
-Executing ``python -m riscv_config.main ==help`` should display the same help message as above.
+Executing ``python -m riscv_config.main --help`` should display the same help message as above.
 
 Usage Example
 =============

riscv_config/__init__.py

@@ -1,3 +1,3 @@
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
-__version__ = "2.0.0"
+__version__ = "2.0.1"