Merge pull request #146 from byuccl/next_release

v.1.8.2

INSTALL.rst

@@ -22,11 +22,11 @@ It can be installed using the ``--user`` to avoid permission issues::
 
     > pip install --user spydrnet
     
-It can be to upgraded to a newer release use the ``--upgrade`` flag::
+It can be to upgraded to a newer release by using the ``--upgrade`` flag::
 
-    > pip install --upgrade networkx
+    > pip install --upgrade spydrnet
     
-It can be installed from source archives or distributions avaiable on `GitHub <https://github.com/byuccl/spydrnet/releases>`_ or
+It can be installed from source archives or distributions available on `GitHub <https://github.com/byuccl/spydrnet/releases>`_ or
 `PyPI <https://pypi.python.org/pypi/spydrnet>`_::
 
     > pip install spydrnet-<version>.tar.gz
@@ -54,7 +54,7 @@ SpyDrNet can be installed in editable mode from within the directory of its repo
 
     > pip install -e .
 
-Editable mode allows modification of the source to be reflected in the use of the module the next time that it is imported into Python. This functionality is convienent for development.
+Editable mode allows modification of the source to be reflected in the use of the module the next time that it is imported into Python. This functionality is convenient for development.
 
 The project repository can be cloned using `Git <https://git-scm.com/>`_. The following commands clone the repository and enter its directory::
 

RELEASE.rst

@@ -1,3 +1,11 @@
+SpyDrNet 1.8.2
+--------------
+June 24, 2021
+
+* updated tutorial 
+* improved How To Contribute page
+* general documentation improvements
+
 SpyDrNet 1.8.1
 --------------
 May 21, 2021

docs/source/developer/contribute.rst

@@ -33,11 +33,15 @@ may mask warnings and errors and ensure the process is smooth.
 
 For the release ensure that both:
 
-`make html`
+>>> make html
 
 and
 
-`make latexpdf`
+>>> make latexpdf
+
+if you are missing packages run:
+
+>>> make install
 
 build the documentation without error as the html version will be put online at 
 the time of release and the pdf should be included in the releases files on
@@ -69,7 +73,7 @@ In the examples below, replace 1.5.0 with the version number you want to release
 
 **To see the current version number**
 
-`git describe`
+>>> git describe
 
 **Creation**
 
@@ -79,6 +83,8 @@ In the examples below, replace 1.5.0 with the version number you want to release
 
 >>> git push --tags
 
+If you mess up, you can use the following instructions to force update your tag
+
 **Updating**
 
 >>> git tag -a v1.5.0 -m "SpyDrNet 1.5.0" -f
@@ -106,6 +112,8 @@ The build files will be stored in the following directories
 
 spydrnet/build and spydrnet/dist
 
+.. _Build:
+
 Building the documentation
 --------------------------
 
@@ -136,20 +144,52 @@ proper release number.
 A description should be entered as well. It could just be a reiteration of the
 release notes or other relevant information.
 
+Three files should be added as assets to the new release:
+
+Two files will be generated when the repository is pushed to Pypi. A tar.gz file and a .whl file. 
+Uploead these two files after performing the next step of `Publising the packages to Pypi`
+
+Go to docs/latex folder, copy the `spydrnet_reference.pdf` to the assets under the new release,
+and changes its name to `spydrnet_reference-new_release_number.pdf`. If the pdf file doesn't exist, run:
+
+>>> make latexpdf
+
+in the /docs folder
+
 Publishing the packages to Pypi
 -------------------------------
 
-The packages need to be published to Pypi to be installable via pip. On pypi.org
-there is a guide on uploading packages. Follow the instructions there to upload
+The packages need to be published to Pypi to be installable via pip. On the `Pypi website <https://packaging.python.org/tutorials/packaging-projects/>`_
+there is a guide on uploading packages. You will need an account for this. Follow the instructions there to upload
 to the test pip server then the production server.
 
+If you have an account and know what you are doing, use the command below :
+
+>>> python3 -m twine upload dist/*
+
+And then input your username and password for Pypi.
+
+To install the python package to check for success, use:
+
+>>> python3 -m pip install spydrnet
+
+Go to the release on the Pypi website through your account. Download the .whl file and the .tar.gz file.
+Add them as assets to the new release at GitHub.com
+
 Publishing the documentation
 ----------------------------
 
 This is easiest on Linux (or at least not Windows, MacOS works fine as well)
 
+Make sure you are still in the Master branch and that everything in the html folder is up-to-date.
+If not, re-run the instructions in :ref:`Build`.
+
 Checkout the gh-pages branch create a new folder with the release number as the
-name. Copy the `docs/build/html` folder into the newly created folder.
+name. Move the `docs/build/html` folder into the newly created folder. 
+Make sure to delete the html folder after you are finished.
+
+(If html folder doesn't contain the latest pages, it could be that the html folder wasn't deleted from the previous release,
+delete the folder, commit the changes and repeat the steps above)
 
 The documentation is built from the stable link so the stable link will need to
 be updated to point to the newly updated documentation.

docs/source/reference/classes/index.rst

@@ -22,7 +22,7 @@ The API calls documented here can be used in Python as follows:
 >>> library = netlist.create_library()
 >>>
 
-Similarly if the parser is used the calls can be made in the same way:
+If the parser is used, the calls can be made in the same way:
 
 >>> # parse an edif file in and add an empty library to the netlist.
 >>> import spydrnet as sdn
@@ -54,7 +54,7 @@ Basic object types
    parse
 
 The following three classes are the classes from which the above elements inherit. They are included here for completeness of
-documentation and can be used if needed. if the above types will suffice it may be simpler to use them.
+documentation and can be used if needed. If the above types will suffice it may be simpler to use them.
 
 .. currentmodule:: spydrnet.ir
 .. autosummary::

docs/source/reference/classes/outerpin.rst

@@ -19,6 +19,7 @@ Methods
    OuterPin.from_instance_and_inner_pin
    OuterPin.instance
    OuterPin.inner_pin
+   OuterPin.wire
    OuterPin.clone
    OuterPin.get_netlists
    OuterPin.get_libraries

docs/source/reference/classes/wire.rst

@@ -21,6 +21,7 @@ Methods
    Wire.connect_pin
    Wire.disconnect_pin
    Wire.disconnect_pins_from
+   Wire.index
    Wire.clone
    Wire.get_netlists
    Wire.get_libraries