Skip to content

Commit

Permalink
idaes-dev 1.6_rel as of d1e6f11 for 1.6.3
Browse files Browse the repository at this point in the history
  • Loading branch information
ksbeattie committed Aug 20, 2020
1 parent e95a356 commit 50c3474
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 7 deletions.
11 changes: 11 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,17 @@
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

# This block of text will be virtually present at the end of every file.
# Used here to define substitutions for re-used URLs, e.g. just add "|examples-site|" to
# any page and it will be replaced with the hyperlink and text shown below.
rst_epilog = """
.. |examples-site| replace:: `examples online documentation page`_
.. _examples online documentation page: https://idaes.github.io/examples-pse/latest/index.html
.. |github-issues| replace:: `Github issues page`_
.. _Github issues page: https://github.com/IDAES/idaes-pse/issues
"""

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ appropriate for your needs and operating system. If you get stuck, please contac
`[email protected] <[email protected]>`_.

After installing and testing IDAES, it is strongly recommended to do the IDAES tutorials
located on the `IDAES examples site <https://examples-pse.readthedocs.io/en/stable/tutorials/index.html>`_.
located on the |examples-site|.

If you expect to develop custom models, we recommend following the
:ref:`advanced user installation<advanced_user_guide/advanced_install/index:Advanced User Installation>`.
Expand Down Expand Up @@ -172,5 +172,5 @@ Powershell Prompt. Regardless of OS and shell, the following steps are the same
5. You should see the tests run and all should pass to ensure the installation worked. You
may see some "Error" level log messages, but they are okay, and produced by tests for
error handling. The number of tests that failed and succeeded is reported at the end of the pytest
output. You can report problems on the `Github issues page <https://github.com/IDAES/idaes-pse/issues>`_
output. You can report problems on the |github-issues|
(Please try to be specific about the command and the offending output.)
3 changes: 1 addition & 2 deletions docs/tutorials_examples.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Tutorials and Examples
======================

Tutorials and examples for IDAES are located at the `IDAES examples site <https://examples-pse.readthedocs.io/en/stable/>`_.
Tutorials and examples for IDAES are located on the |examples-site|.

These tutorials and examples are maintained on the
`IDAES examples repository <https://github.com/IDAES/examples-pse>`_. You can install the associated
Expand All @@ -15,4 +15,3 @@ If you want to develop custom unit and property models refer to the
:ref:`advanced user guide <advanced_user_guide/index:Advanced User Guide>`.



4 changes: 2 additions & 2 deletions docs/user_guide/workflow/general.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ While IDAES offers significant freedom in how users write their models, they
are encouraged to follow this general workflow in order to make it easier for others to follow
their code.

This workflow is used throughout the tutorials and examples on the `IDAES examples site <https://examples-pse.readthedocs.io/en/stable/>`_.
This workflow is used throughout the tutorials and examples on the |examples-site|.

.. note::

Expand Down Expand Up @@ -251,4 +251,4 @@ One of the benefits of the IDAES modeling framework is that it operates in a ful
programming language, which provides users a high degree of flexibility in analyzing their
models. For example, users can automate the simulation of the model across multiple objectives
or a range of parameters, store and save results from one or multiple solutions. Users also have
access to a wide range of tools for manipulating, plotting and visualizing the results.
access to a wide range of tools for manipulating, plotting and visualizing the results.
2 changes: 1 addition & 1 deletion idaes/ver.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ def git_hash():
pass

#: Package's version as an object
package_version = Version(1, 6, 2, "final", 0, gh)
package_version = Version(1, 6, 3, "final", 0, gh)

#: Package's version as a simple string
__version__ = str(package_version)
Expand Down

0 comments on commit 50c3474

Please sign in to comment.